Repository navigation
docs: add releasing.md #375
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.
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
Merged
+38
−0
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Releasing `chrome-launcher` | ||
|
|
||
| Releases are published automatically to npm via GitHub Actions using [npm Trusted Publishing](https://docs.npmjs.com/trusted-publishers) (OIDC provenance) when a version tag (`v*`) is pushed. | ||
|
|
||
| ## Release Steps | ||
|
|
||
| 1. **Ensure `main` is up to date and clean:** | ||
| ```sh | ||
| git checkout main | ||
| git pull origin main | ||
| ``` | ||
|
|
||
| 2. **Update `changelog.md`:** | ||
| Add a new section at the top of [`changelog.md`](../changelog.md) for the new version (e.g. `## vX.Y.Z (Day, Mon DD YYYY)`) listing the commits/changes since the previous tag: | ||
| ```sh | ||
| git log $(git describe --tags --abbrev=0)..HEAD --oneline | ||
| ``` | ||
|
|
||
| 3. **Bump the version in `package.json`, commit, and tag:** | ||
| Update `"version"` in [`package.json`](../package.json) to `X.Y.Z`, then commit and tag `vX.Y.Z`: | ||
| ```sh | ||
| git add changelog.md package.json | ||
| git commit -m "X.Y.Z" | ||
| git tag vX.Y.Z | ||
| ``` | ||
|
|
||
| 4. **Push the commit and tag to GitHub:** | ||
| ```sh | ||
| git push origin main vX.Y.Z | ||
| ``` | ||
|
|
||
| 5. **Verify the GitHub Actions workflow:** | ||
| Pushing the `vX.Y.Z` tag triggers the [Publish Package](../.github/workflows/publish.yml) workflow, which: | ||
| - Installs dependencies (`yarn --frozen-lockfile`) | ||
| - Builds (`yarn build`) and runs the test suite (`xvfb-run --auto-servernum yarn test`) | ||
| - Publishes to npm with provenance (`npm publish --provenance --access public`) | ||
|
|
||
| The workflow can also be triggered manually from the GitHub Actions tab via `workflow_dispatch` if needed. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
TIL you can do a combo push like that in one command