Skip to content

Commit 3e360ce

Browse files
authored
docs: update CONTRIBUTING.md with new publish guidelines (#1388)
1 parent aff9977 commit 3e360ce

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,12 +113,27 @@ The following is an overview of what's required in order to add support to the a
113113

114114
If you have access to make releases, the process is as follows:
115115

116-
1. Update the version in `package.json` according to the scale of the change. (major, minor or patch)
117-
1. Add commit messages to the changelog (You may skip non-user-visible changes)
116+
#### Current major
117+
118+
1. Be sure you have checked out the `master` branch and have pulled latest changes
119+
1. Update the version in `package.json` according to the scale of the change. (major, minor or patch)
120+
1. Add commit messages to `CHANGELOG.md` (You may skip non-user-visible changes)
118121
1. Commit changes with message `x.y.z` where `x.y.z` is the version in `package.json`
119122
1. Tag the commit with `git tag vx.y.x`, for example `git tag v1.2.3`
120-
1. Reset the current major branch (`1.x`, `2.x` etc) to point to the current master, e.g. `git branch -f 1.x master`
123+
1. Reset the latest major branch (`1.x`, `2.x` etc) to point to the current master, e.g. `git branch -f 3.x master`
121124
1. Run tests with `npm test`
122125
1. Push commits and tags upstream with `git push upstream master && git push upstream --tags` (and optionally to your own fork as well)
123-
1. Update 1.x branch on upstream with `git push upstream 1.x`
126+
1. Update the latest major branch on upstream with `git push upstream <major_branch>`
124127
1. Publish to npm with `npm publish`
128+
129+
#### Past major
130+
131+
1. Be sure you have checked out the branch associated with the major you wish to release and have pulled latest changes, e.g. `2.x`
132+
1. Update the version in `package.json` according to the scale of the change. (major, minor or patch)
133+
1. Add commit messages to `CHANGELOG.md` (You may skip non-user-visible changes)
134+
1. Commit changes with message `x.y.z` where `x.y.z` is the version in `package.json`
135+
1. Tag the commit with `git tag vx.y.x`, for example `git tag v1.2.3`
136+
1. Run tests with `npm test`
137+
1. Push commits and tags upstream with `git push upstream <major_branch> && git push upstream --tags` (and optionally to your own fork as well)
138+
1. Publish to npm with `npm publish --tag v2` (where `v2` is the tag for the past major version being published)
139+
1. Make a PR against `master` containing the updates to `CHANGELOG.md` so that `master` always contain information about all releases

0 commit comments

Comments
 (0)