diff --git a/README.md b/README.md index 21c3a97..d0b90af 100644 --- a/README.md +++ b/README.md @@ -214,3 +214,17 @@ parser.parse('ROWS(A1:E2)'); // returns `2` parser.parse('COUNT(A1:E2)'); // returns `10` parser.parse('COUNTIF(A1:E2, ">5")'); // returns `5` ``` + +## Releasing + +To publish a new version of the package: + +1. **Create a release** by running: + ```sh + $ npm run release + ``` + This uses [`generate-release`](https://www.npmjs.com/package/generate-release) to bump the version in `package.json`, create a git tag, and push changes. + +2. **Publish to GitHub Packages** happens automatically — the `.github/workflows/publish.yml` workflow triggers when a GitHub Release is published, building and publishing the package to the GitHub Packages registry. + +Before publishing, the `prepublishOnly` hook automatically runs linting, tests, and the build to ensure the package is in a good state.