Skip to content

Commit

Permalink
Add release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jaap3 authored Dec 7, 2023
1 parent 03aa1c3 commit 8a9125c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,11 @@ module.exports = {
To reduce the chances of publishing bugs, test your package before publishing it to the npm registry. Run npm install with the full path to your package directory. You can get this path with `pwd` in your terminal.

`npm install <local path to this repo>`

## Releasing this package

Use the [Bump NPM version](https://github.com/leukeleu/stylelint-config/actions/workflows/npm-version.yml) action to increase a version part. This will also create a new tag.

Once the tag is created, [draft a new release](https://github.com/leukeleu/stylelint-config/releases/new). Pick the newly created tag and let GitHub generate the release notes.

Finally, click "Publish release" and wait for the release action to upload the package to NPM.

0 comments on commit 8a9125c

Please sign in to comment.