Skip to content

docs(fields): add releasing instructions to README [CLK-1095757] #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mysza merged 1 commit into from
Mar 31, 2026
+14 −0
Merged

docs(fields): add releasing instructions to README [CLK-1095757] #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading