Skip to content

Commit 4eb06ff

Browse files
authored
Merge pull request #2399 from processing/chore/add-patch-release-docs
add documentation for creating a patch release
2 parents 62df487 + ccb3fd6 commit 4eb06ff

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

contributor_docs/release.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,28 @@ This project release guide is based on
2525

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

28+
29+
## Steps for a Patch Release
30+
Sometimes you might need to push a release for an isolated and small bug fix without what's currently been merged into the `develop` branch. The steps for pushing a Patch Release are similar to a standard Release, except you work with the `release` branch as opposed to `develop`.
31+
32+
1. `$ git checkout release`
33+
2. `$ git pull origin release`
34+
3. `$ git checkout -b release-<newversion>` (increment patch version)
35+
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.
36+
5. `$ npm version <newversion>` (see [npm-version](https://docs.npmjs.com/cli/version) for valid values of )(npm version patch).
37+
6. `$ git checkout release`
38+
7. `$ git merge --no-ff release-<newversion>`
39+
8. `$ git push && git push --tags`
40+
9. `$ git checkout develop`
41+
10. `$ git merge --no-ff release-<newversion>`
42+
11. `$ git push origin develop`
43+
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!
44+
45+
### What if the PR Bug Fix is branched from `develop`?
46+
47+
1. Make a copy of the branch locally: `gh pr checkout ##`
48+
2. `git checkout release`
49+
3. `git pull origin release`
50+
4. `git checkout -b <descriptive-branch-name>`
51+
5. `git cherry-pick <every sha in PR branch>`
52+
6. Make a new PR that merges into `release` (has a base branch `release`)

0 commit comments

Comments
 (0)