Skip to content

Commit 528a885

Browse files
authored
Merge pull request #2076 from processing/chore/release_docs
Update release documentation with GitHub generated release notes
2 parents f0a1f96 + 843e88e commit 528a885

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

contributor_docs/release.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,17 @@ This project release guide is based on
1111

1212
## Steps
1313
1. `$ git checkout develop`
14-
2. `$ git checkout -b release-<newversion>`
15-
3. Do all of the release branch testing necessary. This could be as simple as running `npm test:ci`, or it could take user testing over a few days.
16-
4. `$ npm version <newversion>` (see [npm-version](https://docs.npmjs.com/cli/version) for valid values of <newversion>).
17-
5. `$ git checkout release`
18-
6. `$ git merge --no-ff release-<newversion>`
19-
7. `$ git push && git push --tags`
20-
8. `$ git checkout develop`
21-
9. Create a release on GitHub. Make sure that you release from the `release` branch! You can do this in one of two ways:
22-
1. (Preferred) Use the [`hub` command line tool](https://hub.github.com/). You can automate adding all commit messages since the last release with the following command:
23-
```sh
24-
$ hub release create -d -m "<newversion>" -m "$(git log `git describe --tags --abbrev=0 HEAD^`..HEAD --oneline)" <newversion>`
25-
```
26-
Note that this creates a draft release, which you can then edit on GitHub. This allows you to create release notes from the list of commit messages, but then edit these notes as you wish.
27-
2. [Draft a new release on Github](https://github.com/processing/p5.js-web-editor/releases/new).
14+
2. `$ git pull origin develop`
15+
3. `$ git checkout -b release-<newversion>`
16+
4. Do all of the release branch testing necessary. This could be as simple as running `npm test:ci`, or it could take user testing over a few days.
17+
5. `$ npm version <newversion>` (see [npm-version](https://docs.npmjs.com/cli/version) for valid values of <newversion>).
18+
6. `$ git checkout release`
19+
7. `$ git merge --no-ff release-<newversion>`
20+
8. `$ git push && git push --tags`
21+
9. `$ git checkout develop`
2822
10. `$ git merge --no-ff release-<newversion>`
23+
11. `$ git push origin develop`
24+
12. [Draft a new release on Github](https://github.com/processing/p5.js-web-editor/releases/new). Choose the tag that is the release version you just created, and then title it `v<newversion>`. Then click "Generate release notes". Publish the release and you are finished!
2925

3026
Travis CI will automatically deploy the release to production, as well as push a production tagged Docker image to DockerHub.
3127

0 commit comments

Comments
 (0)