Skip to content

Commit

Permalink
Update README with publishing steps
Browse files Browse the repository at this point in the history
  • Loading branch information
atkinchris committed Sep 10, 2024
1 parent f63d07a commit 7347aab
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,3 +123,15 @@ module.exports = {
## Breaking Changes on >=1.0.0

This package name, `next-logger` has been inherited from [@frank47](https://github.com/franky47), who had deprecated their published logging middleware for Next.js. The original package and this one aim to solve similar problems for JSON logging in Next.js. However, the implementation and usage of this solution is significantly different from the original, which was published up to `v0.4.0`. To minimise unexpected issues for previous users of the original `next-logger`, the new package begins at major `v1.0.0`.

## Release changes

Changes are published to `npm`, however with 2FA rules in place for security, this cannot be achieved through GitHub Actions at this time. To release a new version, merge all work intended to be in the release, and then follow these steps:

```sh
npm version <major|minor|patch>
git push --follow-tags
npm publish
```

Then create a new release on GitHub, pointing to the tag created by `npm version`.

0 comments on commit 7347aab

Please sign in to comment.