-
Notifications
You must be signed in to change notification settings - Fork 404
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1938 +/- ##
==========================================
- Coverage 92.14% 92.12% -0.02%
==========================================
Files 189 189
Lines 10809 10809
Branches 1581 1581
==========================================
- Hits 9960 9958 -2
- Misses 849 851 +2
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for updating the docs, Katrina!
Previously we did the pre-release on master, which leaves room for master to move forward during QA testing. I just ran into this with the 0.25.0 release (which ended up being the 0.26.0 release due to these complications 😳).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should ✂️ the second "release branch creation" step. Other than that 💯
docs/how-we-work.md
Outdated
1. Check if a release commit was created (`git log`). If one exists, remove it from the commit history (`git reset --hard <sha-prior-to-commit>`). | ||
1. Check if a release tag was created (`git tag`). If one exists, delete it (`git tag -d 0.${MINOR}.0`). | ||
1. Address the problem that interfered with publishing. | ||
1. Try to publish again with `apm publish minor`. | ||
9. _In your atom/github repository:_ create a release branch for this minor version with `git checkout -b 0.${MINOR}-releases`. Push it to atom/github. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This step should be deleted now, yeah?
9. _In your atom/github repository:_ create a release branch for this minor version with `git checkout -b 0.${MINOR}-releases`. Push it to atom/github. | ||
9. _In your atom/atom repository:_ update the version of the `"github"` entry beneath `packageDependencies` in `package.json` to match the published minor version. Run `script/build` to update `package-lock.json` files. Commit and push these changes. | ||
9. _In your atom/atom repository:_ checkout a new branch (`git checkout -b bump-github-${VERSION}`), update the version of the `"github"` entry beneath `packageDependencies` in `package.json` to match the published minor version. Run `script/build` to update `package-lock.json` files. Commit and push these changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sidenote: you can get away with just running script/bootstrap
instead of script/build
. But script/build
is safer because it actually runs through the final snapshotting and everything, so let's leave it like this.
I'll update this with any other tweaks I come across as I walk through the rest of the release process
Notable changes:
Removed Atom CI verification step.
Rationale: This step was originally introduced to catch snapshotting problems, but we now have other measures for catching this. Specifically we have a CI job that runs on our atom/github PRs, and we do a local build of Atom with a pre-release package version as part of our release QA testing.
Cut release branch at the start.
Rationale: So that work can continue on master without interfering with the release process.
Added steps for handling when publishing fails (make sure to delete tag and get release commit out of commit history)
View rendered docs/how-we-work.md