Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pbatey committed Jul 2, 2024
1 parent 5c10d19 commit 8c38d1e
Showing 1 changed file with 13 additions and 18 deletions.
31 changes: 13 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,25 +219,20 @@ or...
Creating a Release Manually
---------------------------

1. Ensure all unit tests pass with `npm test`
2. Use `npm version major|minor|patch` to increment the version in _package.json_ and tag the release
3. Push the tags `git push origin master --tags`
4. Publish the release `npm publish ./`
1. Update CHANGELOG.md by moving any changes in the `[Unreleased]` section to a
new release section

### Major Release
```
## Unreleased
npm version major
git push origin master --tags
npm publish ./
## 0.1.0 - 2024-07-02
### Added
- Initial Version
```

### Minor Release (backwards compatible changes)
And commit it with `git add CHANGELOG.md && git commit -m 'chore: Update CHANGELOG.md`

npm version minor
git push origin master --tags
npm publish ./

### Patch Release (bug fix)

npm version patch
git push origin master --tags
npm publish ./
2. Ensure all unit tests pass with `npm test`
3. Use `npm version major|minor|patch` to increment the version in _package.json_ and tag the release
4. Push the tags `git push origin master --tags`
5. Publish the release `npm publish ./`

0 comments on commit 8c38d1e

Please sign in to comment.