rohit/probo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update release guides

Browse Source 
Signed-off-by: Émile Ré <emile@getprobo.com>
This commit is contained in:
Émile Ré
2026-05-07 16:49:58 +04:00
parent 99c5d0057b
commit 8bd5454ad7
6 changed files with 124 additions and 219 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
contrib/claude/release/README.md
View File

@@ -96,32 +96,39 @@ Format: `## [X.Y.Z] - YYYY-MM-DD` (today's date). Always keep an
## 3. Common steps (every track) ## 3. Common steps (every track)
After choosing the track and reviewing its commits: Open the per-track entrypoint and run its **Detect commits** command.
If the track has no user-facing commits, stop. Otherwise:
1. Bump the version in the track's source of truth (see the per-track 1. Decide the version bump (PATCH for fixes, MINOR for features).
entrypoint). 2. Bump the version using the track's **Version bump** method.
2. Write the changelog entry in the track's `CHANGELOG.md`. 3. If the track lists a **Build** command, run it now to catch compile
3. For npm tracks, run the workspace `build` script after the version errors before tagging.
bump (see the per-track entrypoint for why). 4. Write the changelog entry in the track's **Changelog** file following
4. Show the user the proposed `CHANGELOG.md` diff and the new version. the rules in [section 2](#2-writing-a-changelog-entry).
Wait for confirmation. 5. Show the user the proposed changelog diff and the new version. Wait
5. Commit only the files modified by the version bump and changelog for confirmation.
edit. Subject: `Release <pkg>/v<version>`. No body. 6. Stage only the files listed in the track's **Files to stage**.
6. Annotated tag: `git tag -a <pkg>/v<version> -m "<pkg>/v<version>"`. Commit subject: `Release <pkg>/v<version>`. No body.
7. Push: `git push origin main --follow-tags`. 7. Annotated tag: `git tag -a <pkg>/v<version> -m "<pkg>/v<version>"`.
8. Push the commit: `git push origin main`.
9. Push the tag **separately**: `git push origin <pkg>/v<version>`.
CI handles the rest: binary builds, npm publish, Docker image, Homebrew Each tag must be pushed in its own `git push` command so the
formula, SBOMs, attestations, GitHub Release. corresponding GitHub Actions workflow fires reliably. Pushing multiple
tags at once (e.g. `--follow-tags`) can silently skip workflow triggers.
When releasing multiple tracks in one session, push each track's tag
immediately after creating it, before moving on to the next track.
## Checklist (every track) ## Checklist (every track)
1. [ ] Pulled latest `main` 1. [ ] Pulled latest `main`
2. [ ] Confirmed the track has user-facing commits since its last tag 2. [ ] Track has user-facing commits since its last tag
3. [ ] Reviewed track-specific commits 3. [ ] Version bumped per track's **Version bump** method
4. [ ] Track CHANGELOG entry written, categorized, summarized 4. [ ] (npm tracks) **Build** command succeeded
5. [ ] Version bumped in the track's source of truth 5. [ ] Changelog entry written, categorized, summarized
6. [ ] (npm tracks) Workspace `build` script run successfully after bump 6. [ ] User confirmed changelog and version
7. [ ] User confirmed changelog and version 7. [ ] Commit: `Release <pkg>/v<version>`
8. [ ] Commit message is `Release <pkg>/v<version>` 8. [ ] Annotated tag `<pkg>/v<version>`
9. [ ] Annotated tag `<pkg>/v<version>` on the release commit 9. [ ] Pushed commit to `main`
10. [ ] Pushed commit and tag 10. [ ] Pushed tag independently

84
contrib/claude/release/cookie-banner.md
View File

@@ -1,73 +1,37 @@
# Release `@probo/cookie-banner` # Release `@probo/cookie-banner`
Entrypoint for releasing the cookie banner SDK. Read After confirming commits below, follow the
[README.md](./README.md) first for overall flow, changelog rules, and the [common steps](./README.md#3-common-steps-every-track).
non-empty-track guarantee.
## Track facts ## Track facts
- **Tag pattern**: `@probo/cookie-banner/v*` - **Tag pattern**: `@probo/cookie-banner/v*`
- **Version source**: `packages/cookie-banner/package.json` - **Version source**: `packages/cookie-banner/package.json`
- **Version bump**: `npm --workspace @probo/cookie-banner version <X.Y.Z> --no-git-tag-version`
- **Build**: `npm --workspace @probo/cookie-banner run build`
- **Changelog**: `packages/cookie-banner/CHANGELOG.md` - **Changelog**: `packages/cookie-banner/CHANGELOG.md`
- **Files to stage**: `packages/cookie-banner/package.json`,
`packages/cookie-banner/CHANGELOG.md`, `package-lock.json`
- **Workflow**: `.github/workflows/release-npm-cookie-banner.yaml` - **Workflow**: `.github/workflows/release-npm-cookie-banner.yaml`
- **Path filter** (for log/scoping): `packages/cookie-banner` - **Path filter**: `packages/cookie-banner`
## Important: build script bakes the version ## Detect commits
```shell
git log $(git describe --tags --abbrev=0 --match='@probo/cookie-banner/v*')..HEAD --oneline \
-- packages/cookie-banner
```
If empty or non-user-facing only, do not release this track.
## Notes
`packages/cookie-banner/build.mjs` reads `version` from `package.json` `packages/cookie-banner/build.mjs` reads `version` from `package.json`
and exposes it to the bundle as the `__SDK_VERSION__` define. The SDK and exposes it as the `__SDK_VERSION__` define. The SDK uses this at
uses this value at runtime (e.g. when calling the Probo REST API), so runtime, so the build **must** run after the version bump. The release CI
the build **must** run after the version bump to make sure the new also runs the build, but running it locally catches compile errors before
version is what gets published. The release CI workflow does run the tagging and ensures tracked side-effects (`package-lock.json`) are part
build, but we still run it locally as part of the release commit so: of the release commit.
- compile errors are caught before tagging, CI verifies the tag matches `package.json`, runs the build, publishes to
- any tracked side-effects (`package-lock.json`, etc.) are part of the npm with provenance + SBOM, and creates a GitHub Release.
same `Release @probo/cookie-banner/v<version>` commit.
## Steps
1. From a clean `main`, list commits since the last
`@probo/cookie-banner` tag:
```shell
git log $(git describe --tags --abbrev=0 --match='@probo/cookie-banner/v*')..HEAD --oneline \
-- packages/cookie-banner
```
If the list is empty (or contains only non-user-facing commits), do
not release this track.
2. Decide the version bump (PATCH for fixes, MINOR for features).
3. Bump the version using npm so `package.json` and `package-lock.json`
stay consistent:
```shell
npm --workspace @probo/cookie-banner version <X.Y.Z> --no-git-tag-version
```
4. Run the workspace build so `__SDK_VERSION__` is rebuilt from the new
`package.json` and any compile error surfaces before we tag:
```shell
npm --workspace @probo/cookie-banner run build
```
`dist/` is gitignored, so this step does not produce checked-in build
artifacts — but it must succeed for the release to be valid.
5. Write the new entry in `packages/cookie-banner/CHANGELOG.md` following
the rules in [README.md](./README.md#2-writing-a-changelog-entry).
6. Show the user the changelog diff and the new version. Wait for
confirmation.
7. Stage the files modified by the version bump and changelog edit
(typically `packages/cookie-banner/package.json`,
`packages/cookie-banner/CHANGELOG.md`, and `package-lock.json`).
Commit subject: `Release @probo/cookie-banner/v<version>`. No body.
8. Annotated tag:
`git tag -a @probo/cookie-banner/v<version> -m "@probo/cookie-banner/v<version>"`.
9. Push: `git push origin main --follow-tags`.
CI workflow `release-npm-cookie-banner.yaml` verifies the tag matches
`package.json`, runs the build again, publishes to npm with provenance +
SBOM, and creates a GitHub Release.

61
contrib/claude/release/n8n-nodes-probo.md
View File

@@ -1,58 +1,31 @@
# Release `@probo/n8n-nodes-probo` # Release `@probo/n8n-nodes-probo`
Entrypoint for releasing the n8n nodes package. Read After confirming commits below, follow the
[README.md](./README.md) first for overall flow, changelog rules, and the [common steps](./README.md#3-common-steps-every-track).
non-empty-track guarantee.
## Track facts ## Track facts
- **Tag pattern**: `@probo/n8n-nodes-probo/v*` (the `@` and `/` are valid - **Tag pattern**: `@probo/n8n-nodes-probo/v*` (the `@` and `/` are
in Git tag refs) valid in Git tag refs)
- **Version source**: `packages/n8n-node/package.json` - **Version source**: `packages/n8n-node/package.json`
- **Version bump**: `npm --workspace @probo/n8n-nodes-probo version <X.Y.Z> --no-git-tag-version`
- **Build**: `npm --workspace @probo/n8n-nodes-probo run build`
- **Changelog**: `packages/n8n-node/CHANGELOG.md` - **Changelog**: `packages/n8n-node/CHANGELOG.md`
- **Files to stage**: `packages/n8n-node/package.json`,
`packages/n8n-node/CHANGELOG.md`, `package-lock.json`
- **Workflow**: `.github/workflows/release-npm-n8n-node.yaml` - **Workflow**: `.github/workflows/release-npm-n8n-node.yaml`
- **Path filter** (for log/scoping): `packages/n8n-node` - **Path filter**: `packages/n8n-node`
## Steps ## Detect commits
1. From a clean `main`, list commits since the last ```shell
`@probo/n8n-nodes-probo` tag: git log $(git describe --tags --abbrev=0 --match='@probo/n8n-nodes-probo/v*')..HEAD --oneline \
```shell
git log $(git describe --tags --abbrev=0 --match='@probo/n8n-nodes-probo/v*')..HEAD --oneline \
-- packages/n8n-node -- packages/n8n-node
``` ```
If the list is empty (or contains only non-user-facing commits), do If empty or non-user-facing only, do not release this track.
not release this track.
2. Decide the version bump (PATCH for fixes, MINOR for features). ## Notes
3. Bump the version using npm so `package.json` and `package-lock.json`
stay consistent:
```shell CI verifies the tag matches `package.json`, publishes to npm with
npm --workspace @probo/n8n-nodes-probo version <X.Y.Z> --no-git-tag-version provenance + SBOM, and creates a GitHub Release.
```
4. Run the workspace build to confirm it succeeds with the new version
(and to surface any compile errors before we tag):
```shell
npm --workspace @probo/n8n-nodes-probo run build
```
5. Write the new entry in `packages/n8n-node/CHANGELOG.md` following the
rules in [README.md](./README.md#2-writing-a-changelog-entry).
6. Show the user the changelog diff and the new version. Wait for
confirmation.
7. Stage the files modified by the version bump and changelog edit
(typically `packages/n8n-node/package.json`,
`packages/n8n-node/CHANGELOG.md`, and `package-lock.json`). Commit
subject: `Release @probo/n8n-nodes-probo/v<version>`. No body.
8. Annotated tag:
`git tag -a @probo/n8n-nodes-probo/v<version> -m "@probo/n8n-nodes-probo/v<version>"`.
9. Push: `git push origin main --follow-tags`.
CI workflow `release-npm-n8n-node.yaml` verifies the tag matches
`package.json`, publishes to npm with provenance + SBOM, and creates a
GitHub Release.

42
contrib/claude/release/prb.md
View File

@@ -1,42 +1,28 @@
# Release `prb` (CLI) # Release `prb` (CLI)
Entrypoint for releasing the `prb` CLI. Read [README.md](./README.md) After confirming commits below, follow the
first for overall flow, changelog rules, and the [common steps](./README.md#3-common-steps-every-track).
non-empty-track guarantee.
## Track facts ## Track facts
- **Tag pattern**: `prb/v*` - **Tag pattern**: `prb/v*`
- **Version source**: `cmd/prb/VERSION` (contains only `X.Y.Z`) - **Version source**: `cmd/prb/VERSION` (single `X.Y.Z` line)
- **Version bump**: Edit `cmd/prb/VERSION` directly
- **Changelog**: `cmd/prb/CHANGELOG.md` - **Changelog**: `cmd/prb/CHANGELOG.md`
- **Files to stage**: `cmd/prb/VERSION`, `cmd/prb/CHANGELOG.md`
- **Workflow**: `.github/workflows/release-prb.yaml` - **Workflow**: `.github/workflows/release-prb.yaml`
- **Path filter** (for log/scoping): `cmd/prb pkg/cli pkg/cmd` - **Path filter**: `cmd/prb pkg/cli pkg/cmd`
## Steps ## Detect commits
1. From a clean `main`, list commits since the last `prb` tag: ```shell
git log $(git describe --tags --abbrev=0 --match='prb/v*')..HEAD --oneline \
```shell
git log $(git describe --tags --abbrev=0 --match='prb/v*')..HEAD --oneline \
-- cmd/prb pkg/cli pkg/cmd -- cmd/prb pkg/cli pkg/cmd
``` ```
If the list is empty (or contains only non-user-facing commits), do If empty or non-user-facing only, do not release this track.
not release this track.
2. Decide the version bump (PATCH for fixes, MINOR for features). ## Notes
3. Bump the version in `cmd/prb/VERSION` (the file contains a single
`X.Y.Z` line — no trailing newline conventions beyond what is already
there).
4. Write the new entry in `cmd/prb/CHANGELOG.md` following the rules in
[README.md](./README.md#2-writing-a-changelog-entry).
5. Show the user the changelog diff and the new version. Wait for
confirmation.
6. Stage only `cmd/prb/VERSION` and `cmd/prb/CHANGELOG.md`. Commit
subject: `Release prb/v<version>`. No body.
7. Annotated tag: `git tag -a prb/v<version> -m "prb/v<version>"`.
8. Push: `git push origin main --follow-tags`.
CI workflow `release-prb.yaml` builds binaries for 9 OS/arch targets, CI builds binaries for 9 OS/arch targets, publishes a GitHub Release,
publishes a GitHub Release, and updates the Homebrew formula at and updates the Homebrew formula at `getprobo/homebrew-tap`.
`getprobo/homebrew-tap`.

46
contrib/claude/release/probod-bootstrap.md
View File

@@ -1,44 +1,30 @@
# Release `probod-bootstrap` # Release `probod-bootstrap`
Entrypoint for releasing `probod-bootstrap`. Read [README.md](./README.md) After confirming commits below, follow the
first for overall flow, changelog rules, and the non-empty-track [common steps](./README.md#3-common-steps-every-track).
guarantee.
## Track facts ## Track facts
- **Tag pattern**: `probod-bootstrap/v*` - **Tag pattern**: `probod-bootstrap/v*`
- **Version source**: `cmd/probod-bootstrap/VERSION` (contains only `X.Y.Z`) - **Version source**: `cmd/probod-bootstrap/VERSION` (single `X.Y.Z` line)
- **Version bump**: Edit `cmd/probod-bootstrap/VERSION` directly
- **Changelog**: `cmd/probod-bootstrap/CHANGELOG.md` - **Changelog**: `cmd/probod-bootstrap/CHANGELOG.md`
- **Files to stage**: `cmd/probod-bootstrap/VERSION`,
`cmd/probod-bootstrap/CHANGELOG.md`
- **Workflow**: `.github/workflows/release-probod-bootstrap.yaml` - **Workflow**: `.github/workflows/release-probod-bootstrap.yaml`
- **Path filter** (for log/scoping): `cmd/probod-bootstrap` - **Path filter**: `cmd/probod-bootstrap`
## Steps ## Detect commits
1. From a clean `main`, list commits since the last `probod-bootstrap` ```shell
tag: git log $(git describe --tags --abbrev=0 --match='probod-bootstrap/v*')..HEAD --oneline \
```shell
git log $(git describe --tags --abbrev=0 --match='probod-bootstrap/v*')..HEAD --oneline \
-- cmd/probod-bootstrap -- cmd/probod-bootstrap
``` ```
If the list is empty (or contains only non-user-facing commits), do If empty or non-user-facing only, do not release this track.
not release this track.
2. Decide the version bump (PATCH for fixes, MINOR for features). ## Notes
3. Bump the version in `cmd/probod-bootstrap/VERSION`.
4. Write the new entry in `cmd/probod-bootstrap/CHANGELOG.md` following
the rules in [README.md](./README.md#2-writing-a-changelog-entry).
5. Show the user the changelog diff and the new version. Wait for
confirmation.
6. Stage only `cmd/probod-bootstrap/VERSION` and
`cmd/probod-bootstrap/CHANGELOG.md`. Commit subject:
`Release probod-bootstrap/v<version>`. No body.
7. Annotated tag:
`git tag -a probod-bootstrap/v<version> -m "probod-bootstrap/v<version>"`.
8. Push: `git push origin main --follow-tags`.
CI workflow `release-probod-bootstrap.yaml` builds binaries for 9 OS/arch CI builds binaries for 9 OS/arch targets and publishes a GitHub Release.
targets and publishes a GitHub Release. Note: the same binary, built The same binary, built from the tagged ref, is also bundled into the
from the tagged ref, is also bundled into the probod Docker image when probod Docker image when `probod/v*` runs.
`probod/v*` runs.

51
contrib/claude/release/probod.md
View File

@@ -1,48 +1,37 @@
# Release `probod` (server group) # Release `probod` (server group)
Entrypoint for releasing the `probod` server group. Read
[README.md](./README.md) first for overall flow, changelog rules, and the
non-empty-track guarantee.
This track ships `probod`, `@probo/console`, `@probo/trust`, and This track ships `probod`, `@probo/console`, `@probo/trust`, and
`@probo/ui` together as the Docker image and accompanying binary archive. `@probo/ui` together as the Docker image and accompanying binary archive.
They share the same version. They share the same version.
After confirming commits below, follow the
[common steps](./README.md#3-common-steps-every-track).
## Track facts ## Track facts
- **Tag pattern**: `probod/v*` - **Tag pattern**: `probod/v*`
- **Version source**: `cmd/probod/VERSION` (contains only `X.Y.Z`) - **Version source**: `cmd/probod/VERSION` (single `X.Y.Z` line)
- **Version bump**: Edit `cmd/probod/VERSION` directly
- **Changelog**: `cmd/probod/CHANGELOG.md` (covers all four components) - **Changelog**: `cmd/probod/CHANGELOG.md` (covers all four components)
- **Files to stage**: `cmd/probod/VERSION`, `cmd/probod/CHANGELOG.md`
- **Workflow**: `.github/workflows/release-probod.yaml` - **Workflow**: `.github/workflows/release-probod.yaml`
- **Path filter** (for log/scoping): - **Path filter**: `cmd/probod apps/console apps/trust packages/ui pkg`
`cmd/probod apps/console apps/trust packages/ui pkg`
## Steps ## Detect commits
1. From a clean `main`, list commits since the last `probod` tag: ```shell
git log $(git describe --tags --abbrev=0 --match='probod/v*')..HEAD --oneline \
```shell
git log $(git describe --tags --abbrev=0 --match='probod/v*')..HEAD --oneline \
-- cmd/probod apps/console apps/trust packages/ui pkg -- cmd/probod apps/console apps/trust packages/ui pkg
``` ```
If the list is empty (or contains only non-user-facing commits), do If empty or non-user-facing only, do not release this track.
not release this track.
2. Decide the version bump (PATCH for fixes, MINOR for features). ## Notes
3. Bump the version in `cmd/probod/VERSION`.
4. Write the new entry in `cmd/probod/CHANGELOG.md` covering changes
across `probod`, `@probo/console`, `@probo/trust`, and `@probo/ui`.
Follow the rules in
[README.md](./README.md#2-writing-a-changelog-entry).
5. Show the user the changelog diff and the new version. Wait for
confirmation.
6. Stage only `cmd/probod/VERSION` and `cmd/probod/CHANGELOG.md`.
Commit subject: `Release probod/v<version>`. No body.
7. Annotated tag: `git tag -a probod/v<version> -m "probod/v<version>"`.
8. Push: `git push origin main --follow-tags`.
CI workflow `release-probod.yaml` builds the frontends, builds the Go The changelog covers changes across all four components (`probod`,
binaries, builds and pushes the multi-arch image to `@probo/console`, `@probo/trust`, `@probo/ui`).
`ghcr.io/getprobo/probo:probod-v<version>` (and `:latest`), runs Trivy +
cosign + attestations, and publishes the GitHub Release. CI builds the frontends and Go binaries, builds and pushes the
multi-arch image to `ghcr.io/getprobo/probo:probod-v<version>` (and
`:latest`), runs Trivy + cosign + attestations, and publishes the GitHub
Release.