Skip to content

Commit 51dfca4

Browse files
authored
Merge pull request #36 from time-loop/grok/mysza/docs-fields-add-releasing-instructions-to-readme-to-main-3f07
2 parents c53162e + e878a44 commit 51dfca4

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,3 +214,17 @@ parser.parse('ROWS(A1:E2)'); // returns `2`
214214
parser.parse('COUNT(A1:E2)'); // returns `10`
215215
parser.parse('COUNTIF(A1:E2, ">5")'); // returns `5`
216216
```
217+
218+
## Releasing
219+
220+
To publish a new version of the package:
221+
222+
1. **Create a release** by running:
223+
```sh
224+
$ npm run release
225+
```
226+
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.
227+
228+
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.
229+
230+
Before publishing, the `prepublishOnly` hook automatically runs linting, tests, and the build to ensure the package is in a good state.

0 commit comments

Comments
 (0)