Skip to content

Commit 1f3c3dc

Browse files
Add README section for maintainers
1 parent 2047fe7 commit 1f3c3dc

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,28 @@ punycode.ucs2.encode([0x1D306]);
115115

116116
A string representing the current Punycode.js version number.
117117

118+
## For maintainers
119+
120+
### How to publish a new release
121+
122+
1. On the `main` branch, bump the version number in `package.json`:
123+
124+
```sh
125+
npm version patch -m 'Release v%s'
126+
```
127+
128+
Instead of `patch`, use `minor` or `major` [as needed](https://semver.org/).
129+
130+
Note that this produces a Git commit + tag.
131+
132+
1. Push the release commit and tag:
133+
134+
```sh
135+
git push && git push --tags
136+
```
137+
138+
Our CI then automatically publishes the new release to npm, under both the [`punycode`](https://www.npmjs.com/package/punycode) and [`punycode.js`](https://www.npmjs.com/package/punycode.js) names.
139+
118140
## Author
119141

120142
| [![twitter/mathias](https://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](https://twitter.com/mathias "Follow @mathias on Twitter") |

0 commit comments

Comments
 (0)