@thepalaceproject/circulation-admin 1.34.0-post.1 → 1.34.0-post.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +6 -12
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -102,19 +102,13 @@ The Circulation Manager administrative interface relies on the [OPDS Web Catalog
102
102
 
103
103
  ## Publishing a New Release
104
104
 
105
- Before publishing a new release, update the version number in package.json and add the new version number + comments about what the new version includes to CHANGELOG.md. For new version numbers, you can refer to [Semantic Versioning](https://semver.org/) (major.minor.patch). Then, run `npm install` to update the package-lock.json file to include the new version.
105
+ This package is [published to npm](https://www.npmjs.com/package/@thepalaceproject/circulation-admin) automatically
106
+ via a GitHub Actions workflow when a release is created.
106
107
 
107
- Commit your changes, push them to Github, make a PR, and request your reviewer. Once approved, you may go back to your local repository, checkout the main branch, and `git pull`.
108
-
109
- This package is [published to npm](https://www.npmjs.com/package/simplified-circulation-web). To publish a new version, you need to create an npm account and be a collaborator on the package.
110
-
111
- If you're not already logged in to npm from your terminal, you'll have to do so at this point. Run `npm login` and enter your credentials when prompted.
112
-
113
- Then, you can run `npm publish` from your local copy of the repository (ensure you are on the main branch before doing so).
114
-
115
- Afterwards, you should tag the release and add comments to Github. On the main branch, run `git tag -a v[version number] -m '[commit message]'`. Then run `git push origin v[version number]`.
116
-
117
- Go to the Github repository, click on "tags," find the tag you pushed, click on it and hit "edit." Add a release title, and a description. Then save by clicking, "Update Release."
108
+ When you are ready to publish a release, go to the GitHub repository and create a new release. Specify the version
109
+ number as the tag (e.g., `v1.2.3`), add a release title, and use GitHub's "Generate release notes" feature to
110
+ automatically create documentation based on the PRs included in the release. After reviewing the generated notes,
111
+ publish the release. The GitHub Actions workflow will automatically build, test, and publish the package to npm.
118
112
 
119
113
  ## Accessibility
120
114
 
package/package.json CHANGED
@@ -151,5 +151,5 @@
151
151
  "*.{js,jsx,ts,tsx,css,md}": "prettier --write",
152
152
  "*.{js,css,md}": "prettier --write"
153
153
  },
154
- "version": "1.34.0-post.1"
154
+ "version": "1.34.0-post.2"
155
155
  }