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.

Sign up for GitHub

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

Jump to bottom

Improve release docs ensuring stable official release branch #2726

Merged
merged 4 commits into from
Oct 2, 2024
Merged

Improve release docs ensuring stable official release branch #2726

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f735d3d
Improve release steps ensuring stable official release branch
twelch Oct 1, 2024
f3ed955
nits
twelch Oct 1, 2024
ceea5c7
specifics
twelch Oct 2, 2024
fc5a3b5
update branch delete step
twelch Oct 2, 2024
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
15 changes: 8 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,14 +212,14 @@ Before release:

Run the following release commands, replacing `7.0.0` with your version number:

- create a release branch, replacing `xx` with your initials to make it clear who created the branch.
- `git checkout origin/master -b xx/release-7.0.0`
- 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.
- `git checkout origin/master -b release-7.0.0`

- increment the version number of all packages, and create a local commit, without pushing to origin. This will also create a release tag.
- `pnpm lerna version --no-commit-hooks --no-push 7.0.0`

- Push the release branch and the release tag.
- `git push origin xx/release-7.0.0 --follow-tags`
- `git push origin release-7.0.0 --follow-tags`
- Pushing the tag will trigger the Github [release](https:/Turfjs/turf/blob/master/.github/workflows/release.yml) action which you can view the status of at - https:/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.

- If the release action was not successful
Expand All @@ -228,16 +228,17 @@ Run the following release commands, replacing `7.0.0` with your version number:
- Then reset by deleting your tag and branch locally and remotely.
- `git push --delete origin v7.1.0`
- `git tag --delete v7.1.0`
- `git push -d origin xx/release-7.0.0`
- `git branch -d xx/release-7.0.0`
- `git push -d origin release-7.0.0`
- `git branch -d release-7.0.0`
- Now redo the steps above starting with creating "A clean local copy of the Turf Github repository"

- If the release action was successful, now create a Pull Request for the release to update master.
- If the release action was successful, now create a Pull Request for the release to merge back to master.
- You may be given a link in the output of the branch/tag push command to create the PR.
- If you don't get this message, just go to https:/Turfjs/turf/pulls and you should be prompted at the top to create a PR for this new branch you just pushed.
- 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.
- Here is an example PR - https:/Turfjs/turf/pull/2615.
- Get approval for the release PR and merge it!
- Get approval for the release PR, then "Squash and merge" it.
- 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.

#### Follow-on steps
- As part of the release action, a draft Github release will have been created at https:/Turfjs/turf/releases with an auto-generated changelog.
Expand Down