various
/
Nativefier
mirror of https://github.com/jiahaog/Nativefier
1
0
Fork 0
Code Issues Releases Wiki Activity

release.md: fix pushing tags by using annotated tags, document new CI build based on creating release

This commit is contained in:
Ronan Jouchet 2020-12-06 14:29:42 -05:00
parent 9dc0bed95c
commit 46bc71cb63
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/release.md
View File

@ -22,7 +22,7 @@ While on `master`, with no uncommitted changes,
```bash
npm run changelog -- $VERSION
# For example, npm run changelog -- 7.7.1
# With no 'v'. For example: npm run changelog -- 7.7.1
```
This command does 3 things:
@ -40,11 +40,12 @@ git commit --amend
Once we are satisfied,
```bash
git tag vX.Y.Z
git tag -a vX.Y.Z -m 'vX.Y.Z'
git push --follow-tags origin master
```
On [GitHub Releases](https://github.com/jiahaog/nativefier/releases),
draft and publish a new release with title `Nativefier vX.X.X` (yes, with a `v`).
draft and publish a new release with title `Nativefier vX.Y.Z` (yes, with a `v`).
The new version will be visible on npm within a few minutes/hours.
Our CI will react on the new release, and publish it to npm.
The new version will be visible on npm within a few minutes.