Skip to content

Commit 770f0d5

Browse files
committed
Update release checklist
1 parent 63f58e9 commit 770f0d5

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

RELEASE.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
11
## Release Checklist
22

3-
#### Update version, docs, tag, and publish
4-
- [ ] git checkout main
5-
- [ ] npm install && npm run test
6-
- [ ] Update `CHANGELOG.md`
7-
- [ ] Update version number in `package.json`
8-
- [ ] git add .
9-
- [ ] git commit -m 'vA.B.C'
10-
- [ ] git tag vA.B.C
11-
- [ ] git push origin main vA.B.C
12-
- [ ] npm publish
3+
### Update changelog, version, tag, and publish
4+
5+
```bash
6+
# Make sure your main branch is up to date and all tests pass
7+
git checkout main
8+
git pull origin
9+
npm install
10+
npm run all
11+
12+
# Pick a version, see https://semver.org/ - for example: 'A.B.C' or 'A.B.C-pre.D'
13+
# Update version number in `package.json`
14+
# Update CHANGELOG.md and docs as needed
15+
export VERSION=vA.B.C-pre.D
16+
git add . && git commit -m "$VERSION"
17+
git tag "$VERSION"
18+
git push origin main "$VERSION"
19+
npm publish
20+
```
21+
22+
Set as latest release on GitHub:
23+
- Open https://github.com/osmlab/osm-auth/blob/main/CHANGELOG.md and copy the URL to the new release
24+
- Open https://github.com/osmlab/osm-auth/tags and pick the new tag you just pushed
25+
- There should be a link like "create a release from the tag", click that, and paste in the link to the changelog.

0 commit comments

Comments
 (0)