Skip to content

Commit b4474ff

Browse files
committed
Add documentation for releasing
1 parent 3a4911f commit b4474ff

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

maintainers.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Publishing Package Versions
2+
3+
## Overview
4+
5+
The package is [published to the npm registry](https://www.npmjs.com/package/mdast-util-from-adf) via [GitHub Actions](./.github/workflows/publish.yml). Each time a new GitHub release is created, GitHub Actions will automatically push a new version to npm.
6+
7+
To publish a new version to npm, all you need to do is:
8+
9+
1. Bump the version number in the `package.json` [file](https://github.com/bitcrowd/mdast-util-from-adf/blob/main/package.json)
10+
2. [Create a new release](https://github.com/bitcrowd/mdast-util-from-adf/releases/new)
11+
3. Let the `publish` workflow [do its job](https://github.com/bitcrowd/mdast-util-from-adf/actions/workflows/publish.yml)
12+
13+
For publishing, a valid [npm access token](https://www.npmjs.com/settings/bitcrowd/tokens) is required. We make one available to the workflow as a [secret](https://github.com/bitcrowd/mdast-util-from-adf/settings/secrets/actions).
14+
15+
## References
16+
17+
- https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages

0 commit comments

Comments
 (0)