Skip to content

Commit

Permalink
chore: update release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ThisIsMissEm committed Jun 27, 2022
1 parent a7e1302 commit f625b32
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
17 changes: 8 additions & 9 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,11 @@ This PR fixes bug #.

This PR bumps the version to <version number>.

# Checklist

- [ ] I used `npm run lerna-version -- <major|minor|patch> --no-push` to update the version number, first inspecting the CHANGELOG to determine if the release was major, minor or patch.
- [ ] The CHANGELOG has been updated to show version and release date - https://keepachangelog.com/en/1.0.0/.
- [ ] The **only** commits in this PR are:
- the CHANGELOG update.
- the version update.
- [ ] I will make sure **not** to squash these commits, but **rebase** instead.
- [ ] Once this PR is merged, I will push the tag created by `lerna version ...` (e.g. `git push origin vX.X.X`).
# Release Steps

1. Look at the [CHANGELOG.md](../CHANGELOG.md) to determine whether the release should be a major, minor, or patch release. Coordinate with the team to ensure the next version is agreed upon.
2. Run `npm run lerna-version -- <major|minor|patch>` with the decided on version.
3. Update the `CHANGELOG.md` to release the latest the version, and set the release date.
4. Commit the changes on a `release/vX.Y.Z` branch
5. Push to GitHub, create a PR, and merge once CI passes.
6. Create a release on GitHub for the new version, using a combination of the release notes from the `CHANGELOG.md` and the automatically generated changes.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"test": "lerna run --stream --concurrency=1 --no-prefix --no-bail --ignore e2e-browser test",
"test:e2e:node": "jest --config jest.e2e.config.js",
"test:e2e:browser": "cd e2e/browser && npm test",
"lerna-version": "lerna version",
"lerna-version": "lerna version --no-push --no-git-tag-version",
"install-sandbox": "npm ci && npm ci --prefix .codesandbox/sandbox",
"build-sandbox": "npm run build --prefix .codesandbox/sandbox",
"build-docs-preview-site": "lerna run build-docs-preview-site; rm -r dist/website || true; lerna exec -- mkdir -p ../../dist/website/\\${PWD##*/}; lerna exec -- \"cp -r docs/api/build/html/. ../../dist/website/\\${PWD##*/}/ || true\"; echo 'API documentation: <a href=\"./browser/\">solid-client-authn-browser</a>, <a href=\"./node/\">solid-client-authn-node</a>, <a href=\"./core/\">solid-client-authn-core</a>, <a href=\"./demo/\">demo app</a>.' >> dist/website/index.html",
Expand Down

0 comments on commit f625b32

Please sign in to comment.