purescript-httpurple/Releasing.md
Connor Prussin 2ec5e6826d
Update releasing guide to use pulp publish
Previously this was done in Travis CI but there's really no good reason to
manually push branches and let CI publish instead of just using the publish
command directly.
2021-03-20 16:08:23 -07:00

25 lines
1022 B
Markdown

# HTTPure Releasing Guide
1. Check out the release series branch (or `master` if you are releasing the
next major/minor version). Ensure all relevant commits and PRs have been
merged.
2. Update [History.md](./History.md) by changing "unreleased" to the new
version/date. Example diff:
```diff
-unreleased
-==========
+1.0.0 / 2017-07-10
+==================
```
3. Commit your update to [History.md](./History.md). Use the message `Release
notes for v<new version number>`.
4. Run `pulp version` in the project root. This will check the project for any
issues and create a new version tag and empty checkpoint commit.
5. Run `pulp publish` in the project root. This will publish the commits & tag
to github, will publish the package to bower, and will push documentation to
pursuit.
6. If you are pushing a non-patch release, create and push a branch named with
the version series, i.e. `v0.1.x`.
7. [Create the release on
github](https://github.com/cprussin/purescript-httpure/releases/new).