Skip to content

Commit

Permalink
docs: add release steps
Browse files Browse the repository at this point in the history
  • Loading branch information
luwes authored and dylanjha committed Feb 12, 2024
1 parent a6795f0 commit 2432cf8
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,22 @@ the changes aren't made through the automated pipeline, you may want to make rel

### Publish with a GitHub workflow

You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/muxinc/mux-node-sdk/actions/workflows/publish-npm.yml). This will require a setup organization or repository secret to be set up.
You can release to package managers by using the
[`CD` (continuous deployment) GitHub action](./actions/workflows/cd.yml).
This will require a setup organization or repository secret to be set up.

1. Click the "Run workflow" dropdown and select the branch to release from (`master` in most cases).
1. Choose a version to release (`conventional`, `major`, `minor`, `patch`, `prerelease`, `from-package` or `from-git`)
1. Optionally check the "Dry run" checkbox to test the release without publishing.
1. Click the "Run workflow" button to start the release process.
1. Confirm successful releases at [GitHub](./releases) and [NPM](https://www.npmjs.com/package/@mux/mux-node)

> [!TIP]
> Use the `from-package` option to release a version that matches the version in `package.json`
(useful for first-time releases or when the package version has been updated manually).

> [!TIP]
> Use the `from-git` option to release a version that matches the latest pushed git tag.
### Publish manually

Expand Down

0 comments on commit 2432cf8

Please sign in to comment.