Skip to content

Commit b661e5f

Browse files
committed
ci: Document release workflow, make release manually triggerable
1 parent fe67c5f commit b661e5f

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

.github/workflows/npm-release.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# NPM release
2+
3+
1. Bump version:
4+
```bash
5+
yarn version --patch
6+
```
7+
8+
2. Push changes and tags:
9+
```bash
10+
git push --follow-tags
11+
```
12+
13+
3. [Wait for tag pipeline to become green](https://github.com/buffcode/ntp-packet-parser/actions)
14+
15+
4. [Create a new release on GitHub](https://github.com/buffcode/ntp-packet-parser/releases/new)
16+
- Choose the tag from step 1/2
17+
- Title is `v{version}`
18+
- Give some description on what changed

.github/workflows/npm-release.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
name: Node.js Package
22

33
on:
4+
workflow_dispatch:
45
release:
5-
types: [created]
6+
types: [released]
67

78
jobs:
89
publish:

0 commit comments

Comments
 (0)