Skip to content

Commit 6795a3d

Browse files
rrodrigu3zclaude
andcommitted
docs: add release workflow and document release process
- Add GitHub Release creation to publish workflow (auto-generated notes) - Document release process in CLAUDE.md and README.md - Bump contents permission to write for gh release create Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 064e860 commit 6795a3d

3 files changed

Lines changed: 22 additions & 1 deletion

File tree

.github/workflows/publish.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
publish:
1010
runs-on: ubuntu-latest
1111
permissions:
12-
contents: read
12+
contents: write
1313
id-token: write
1414
steps:
1515
- uses: actions/checkout@v4
@@ -30,3 +30,8 @@ jobs:
3030
- run: pnpm publish --no-git-checks
3131
env:
3232
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
33+
34+
- name: Create GitHub Release
35+
run: gh release create "${{ github.ref_name }}" --generate-notes
36+
env:
37+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CLAUDE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,15 @@ pnpm generate # Regenerate TS from .proto (needs protoc)
5050
- Integration tests gated behind `OPENSHELL_TEST=1` env var
5151
- Generated code excluded from lint and format
5252

53+
## Releasing
54+
55+
```bash
56+
npm version patch # or minor/major — bumps package.json, creates v* tag
57+
git push --follow-tags # pushes tag → CI publishes to npm + creates GitHub Release
58+
```
59+
60+
CI handles everything after the tag push: build, test, npm publish, GitHub Release with auto-generated notes.
61+
5362
## Commit Conventions
5463

5564
Format: `type(scope): description`

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,13 @@ For access to all generated protobuf types (security policies, providers, SSH se
165165
import { SandboxPolicy, NetworkPolicyRule } from "openshell-node/generated";
166166
```
167167

168+
## Releasing
169+
170+
```bash
171+
npm version patch # or minor/major — bumps package.json, creates git tag
172+
git push --follow-tags # tag push triggers CI → npm publish + GitHub Release
173+
```
174+
168175
## Contributing
169176

170177
See [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup and guidelines.

0 commit comments

Comments
 (0)