Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add short howto for release process #564

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions RELEASE_HOWTO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# How to cut a new release

1. Make sure you are on the right branch, usually master
2. Make sure everything that needs to be committed is committed
3. Pick a version number.
* Bugfixes: final digit
* New features visible to user: middle digit
* New way to deploy: middle digit
4. Update the version number in the file `package.json` first, easy to forget.
It's close to the top of the file.
5. Run `npm install` to upgrade the `package-lock.json`-file
6. Update the changelog with `towncrier build --version yournewversionnumber`.
Feel free to massage the generated text!
7. Commit the changes from steps 4 to 6 in the same commit.
8. Tag the commit made in step 7 with an annotated tag with the new version
number.

```
git tag -a -m "Mainly bugfixes" v1.5.1
johannaengland marked this conversation as resolved.
Show resolved Hide resolved
```

Sum up the most important changes in the release in the max. 50 characters
long message.
9. Push everything to github
10. Make a new release on github, this is needed for some automation that
generates a new version in other repos.
Loading