Skip to content

Commit f0133f4

Browse files
committed
docs: add releasing instructions to README
1 parent d4307d2 commit f0133f4

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,17 @@ The library includes comprehensive tests covering:
180180
- Error handling
181181
- Edge cases with negative numbers and mixed types
182182

183+
## Releasing
184+
185+
Releases are published to [Artifactory npm-public](https://packages.atlassian.com/api/npm/npm-public/) and forwarded to npmjs.org.
186+
187+
To publish a new release:
188+
189+
1. Create a [GitHub Release](https://github.com/atlassian-labs/lexicographic-keys/releases/new) with a tag matching the new version (e.g. `1.2.0`).
190+
2. The [Release workflow](.github/workflows/release.yml) will automatically trigger, run tests, and publish the package using `changeset publish` via Artifactory.
191+
192+
> **Note:** Publishing uses [`atlassian-labs/artifact-publish-token`](https://github.com/atlassian-labs/artifact-publish-token) for authentication — no manual npm credentials are required.
193+
183194
## Contributions
184195

185196
Contributions to `@lexicographic/keys` are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.

0 commit comments

Comments
 (0)