You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -212,14 +212,14 @@ Before release:
212
212
213
213
Run the following release commands, replacing `7.0.0` with your version number:
214
214
215
-
- create a release branch, replacing `xx` with your initials to make it clear who created the branch.
216
-
-`git checkout origin/master -b xx/release-7.0.0`
215
+
- create a release branch and switch to it. All building, tagging and publishing will be done on the release branch, and then merged back into master in a later step.
216
+
-`git checkout origin/master -b release-7.0.0`
217
217
218
218
- increment the version number of all packages, and create a local commit, without pushing to origin. This will also create a release tag.
219
219
-`pnpm lerna version --no-commit-hooks --no-push 7.0.0`
220
220
221
221
- Push the release branch and the release tag.
222
-
-`git push origin xx/release-7.0.0 --follow-tags`
222
+
-`git push origin release-7.0.0 --follow-tags`
223
223
- Pushing the tag will trigger the Github [release](https://github.com/Turfjs/turf/blob/master/.github/workflows/release.yml) action which you can view the status of at - https://github.com/Turfjs/turf/actions. If successful, a new [version](https://www.npmjs.com/package/@turf/turf?activeTab=versions) of all turf packages will have been published on NPM.
224
224
225
225
- If the release action was not successful
@@ -228,16 +228,17 @@ Run the following release commands, replacing `7.0.0` with your version number:
228
228
- Then reset by deleting your tag and branch locally and remotely.
229
229
-`git push --delete origin v7.1.0`
230
230
-`git tag --delete v7.1.0`
231
-
-`git push -d origin xx/release-7.0.0`
232
-
-`git branch -d xx/release-7.0.0`
231
+
-`git push -d origin release-7.0.0`
232
+
-`git branch -d release-7.0.0`
233
233
- Now redo the steps above starting with creating "A clean local copy of the Turf Github repository"
234
234
235
-
- If the release action was successful, now create a Pull Request for the release to update master.
235
+
- If the release action was successful, now create a Pull Request for the release to merge back to master.
236
236
- You may be given a link in the output of the branch/tag push command to create the PR.
237
237
- If you don't get this message, just go to https://github.com/Turfjs/turf/pulls and you should be prompted at the top to create a PR for this new branch you just pushed.
238
238
- If that prompt doesn't appear, then just create a new pull request from the PR page and make sure the title is the version number e.g. `v7.0.0` and that it is merging your release branch -> to master.
239
239
- Here is an example PR - https://github.com/Turfjs/turf/pull/2615.
240
-
- Get approval for the release PR and merge it!
240
+
- Get approval for the release PR, then "Squash and merge" it.
241
+
- Do not delete this branch in Github after merging, the release tag points to it. If you do, click "Restore branch" at the bottom of the merged PR.
241
242
242
243
#### Follow-on steps
243
244
- As part of the release action, a draft Github release will have been created at https://github.com/Turfjs/turf/releases with an auto-generated changelog.
0 commit comments