Skip to content

chore(ci): move to Changesets CLI v3 and changesets/action v2 - #317

Merged
jordan-simonovski merged 6 commits into
mainfrom
jordansimonovski/changesets-cli-v3
Nov 18, 2026
Merged

jordan-simonovski merged 6 commits into
mainfrom
jordansimonovski/changesets-cli-v3

Conversation

@jordan-simonovski

Copy link
Copy Markdown
Contributor

Moves release tooling to Changesets CLI v3 and changesets/action v2, the versions Dependabot proposed in #309, without changing what a release produces. Stacked on #316; review once that merges.

  • v3 stops versioning private packages by default. The root package.json is private and its version becomes the chart version, so .changeset/config.json sets privatePackages.version: true. Without it, changeset version consumes the changesets and leaves the version at 3.5.0.
  • Action v2 renames its inputs and the hasChangesets output to has-changesets. The old name reads as empty, which would skip chart-releaser and the GHCR push on every run while the job still passed.
  • Release and helm-test workflows move to Node 22, which v3 requires (^22.11).
  • The tmp resolution goes: v3 replaced external-editor, the only package that pulled tmp in.
  • The Dependabot ignore from fix(ci): pin changesets/action to v1 until the CLI moves to v3 #316 is removed.

No change for chart users. Running yarn changeset locally needs Node 22.11 or later.

Testing

In a scratch worktree on Node 22.23.1 with the six pending changesets:

  • changeset version bumps 3.5.0 to 3.6.0 in package.json and Chart.yaml, and writes the ## 3.6.0 changelog section that extract-release-notes.js reads.
  • changeset publish exits 0, publishes nothing and creates no tags. chart-releaser still does the release.
  • yarn npm audit --all --recursive reports nothing.

Not exercised locally: the action's API-based push and release PR creation. The first real run opens the release PR after this merges; the publish path runs when that release PR merges.

changesets/action v2 refuses to run with @changesets/cli v2, which broke the
release job after #309.
v3 skips private packages unless privatePackages.version is set, and the
root package's version is what becomes the chart version. Action v2 renames
its inputs and the has-changesets output that gates chart-releaser. v3 needs
Node 22.11+, and no longer pulls in tmp, so its resolution goes.
@changeset-bot

changeset-bot Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: c4f0882

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions

github-actions Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

Deep Review

✅ No critical issues found.

This is a self-contained CI/release-tooling change (Changesets CLI v2→v3, changesets/action v1→v2, Node 20→22 via .nvmrc). No Helm templates, values.yaml, or chart manifests are touched, so rendered chart output is unchanged. The verifiable migration mechanics are sound: privatePackages.version: true correctly re-enables versioning the private root helm-charts package under v3, the tmp/external-editor resolution is cleanly removable (0 references remain in yarn.lock), all actions stay SHA-pinned, and the new version-script-smoke step genuinely guards the version-bump regression. All four prior-review items are addressed. The one risk that cannot be verified from the repo — the upstream changesets/action@v2.1.2 input/output contract (network egress is blocked) — is surfaced below as a recommendation rather than a blocker, since the evidence available indicates the names are correct.

🟡 P2 -- recommended

  • .github/workflows/release.yml:51 -- The renamed has-changesets output and new version-script/publish-script/commit-message/pr-title inputs gate the entire post-merge publish path, are exercised only on a real release, and the == 'false' comparison fails open: a wrong/empty output resolves to '', which skips extract-release-notes, chart-releaser, and the GHCR push while the job stays green.
    • Fix: Add a fail-loud guard that errors when steps.changesets.outputs.has-changesets is neither 'true' nor 'false', and/or assert the output name against the pinned action's action.yml at PR time.
    • reliability, testing, correctness
  • .github/workflows/release.yml:47 -- changeset publish (yarn run release) and the action's release-PR/commit creation under the renamed inputs have no PR-time coverage; the version-script-smoke job exercises yarn run version but never the publish path, so the new CLI v3 / action v2 publish wiring first runs in production.
    • Fix: Add a changeset status or changeset publish --dry-run invocation to the smoke job, or a manually-triggerable rehearsal of the release job against a scratch tag.
    • testing
🔵 P3 nitpicks (4)
  • .github/workflows/chart-test.yml:89 -- This PR centralizes release.yml and helm-test.yaml on .nvmrc (=22) but leaves chart-test.yml pinned to node-version: '24', and the rationale lives only in a review comment a maintainer editing this file won't see.
    • Fix: Add a one-line inline comment noting the divergence is intentional (integration suites only, independent of the changesets toolchain).
  • package.json:19 -- engines (^22.11 || ^24 || >=26) and .nvmrc (22) are unenforced parallel Node declarations that can silently drift, and the bare .nvmrc floor is looser than the ^22.11 engines floor; Yarn 4 does not enforce engines at install here.
    • Fix: Tighten .nvmrc to the engines floor or add a comment documenting that the two are advisory and not auto-synced.
  • scripts/install-helm-docs.sh:41 -- The diff newly routes make docs (which curl-downloads helm-docs with no retry) onto the required version-script-smoke check via yarn run version, so a transient GitHub CDN blip now flakes a required PR check.
    • Fix: Add --retry 3 --retry-all-errors --retry-delay 2 --connect-timeout 10 to the curl invocation.
  • package.json:14 -- With the tmp resolution override dropped, no CI step guards against a future dependency update transitively reintroducing a vulnerable tmp/external-editor.
    • Fix: Add a yarn npm audit (or equivalent) gate to CI so reintroduction fails loud.

Reviewers (7): correctness, testing, reliability, maintainability, security, project-standards, previous-comments.

Testing gaps:

  • The has-changesets output-name contract and the changeset publish path run only post-merge, so a wrong rename or publish regression first surfaces on the next real release rather than in CI.

No finding blocks merge automatically. A maintainer will expect P0/P1 findings in code this PR changes to be fixed; P2/P3 are your call -- fix or reply. Never fix findings about surrounding code here; reply instead. Do not widen the PR.

jordan-simonovski added a commit that referenced this pull request Nov 16, 2026
Releases have failed since #309 merged. Dependabot moved
`changesets/action` to v2.1.2, which refuses to run with
`@changesets/cli` v2 ([failed
run](https://github.com/ClickHouse/ClickStack-helm-charts/actions/runs/43963152809)),
so the release PR for the six queued changesets never opens. This pins
the action back to v1.9.0.

- Dependabot now skips major bumps of `changesets/action`, so the next
weekly group PR can't break the release the same way. #317 moves to CLI
v3 and removes the ignore.

No change for chart users; CI only.
Base automatically changed from jordansimonovski/pin-changesets-action-v1 to main November 16, 2026 22:11
- helm-test runs the release's version script against a scratch changeset
  and fails if package.json or Chart.yaml did not bump.
- release and helm-test read the Node version from .nvmrc.
- package.json declares the Node range @changesets/cli v3 supports.
@jordan-simonovski

Copy link
Copy Markdown
Contributor Author

if changesets/action v2.1.2 still emits camelCase hasChangesets, the output resolves to empty string

Not addressing: the pinned v2.1.2 action.yml declares has-changesets (no camelCase output), and src/index.ts:66 sets it with core.setOutput("has-changesets", ...). The three if: expressions match.

Add a PR-time step that runs changeset version against a scratch changeset and asserts package.json/Chart.yaml actually bumped.

Fixed in 759f623. version-script-smoke now runs the release's yarn run version against a scratch changeset and fails if package.json or Chart.yaml didn't bump. It fails as expected with privatePackages.version removed.

Add "engines": { "node": ">=22.11" } to pin the requirement the upgrade introduces.

Fixed in 759f623, using v3's own range (^22.11 || ^24 || >=26), since 23 and 25 aren't supported.

Centralize the Node version

Fixed differently in 759f623: release and helm-test read .nvmrc. chart-test.yml stays on its own '24', because it only uses Node for the integration suites and never runs the changesets tooling.

@github-actions

Copy link
Copy Markdown
Contributor

Helm template coverage

Metric Value
Line coverage 99.85%
Branch coverage 91.00%
Line threshold 99% (met)
Branch threshold 90% (met)
Uncovered details

charts/clickstack/templates/NOTES.txt

Uncovered lines: none

Uncovered branches: 37:default:fallback

charts/clickstack/templates/_helpers.tpl

Uncovered lines: 17

Uncovered branches: 130:range:empty, 132:range:empty, 133:ternary:false, 16:if:true, 194:or(1):true, 211:range:empty, 242:default:fallback, 243:or(1):true, 259:if:false, 327:range:empty, 348:range:empty

charts/clickstack/templates/additional-manifests.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/clickhouse/cluster.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/clickhouse/keeper.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/hyperdx/configmap.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/hyperdx/cronjob-check-alerts.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/hyperdx/dashboard-configmap.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/hyperdx/dashboard-provisioner-rbac.yaml

Uncovered lines: none

Uncovered branches: 40:range:empty

charts/clickstack/templates/hyperdx/deployment.yaml

Uncovered lines: none

Uncovered branches: 121:default:fallback, 131:default:fallback, 196:default:fallback, 201:with:empty, 20:with:empty, 26:default:fallback, 41:if:false, 42:with:empty

charts/clickstack/templates/hyperdx/hpa.yaml

Uncovered lines: none

Uncovered branches: 16:with:empty

charts/clickstack/templates/hyperdx/ingress.yaml

Uncovered lines: none

Uncovered branches: 35:if:false, 40:range:empty, 45:range:empty, 48:with:empty, 54:range:empty, 58:range:empty, 59:or(2):true, 59:or(3):true

charts/clickstack/templates/hyperdx/networkpolicy.yaml

Uncovered lines: none

Uncovered branches: 11:with:empty

charts/clickstack/templates/hyperdx/pdb.yaml

Uncovered lines: none

Uncovered branches: 10:with:empty

charts/clickstack/templates/hyperdx/secret.yaml

Uncovered lines: none

Uncovered branches: 1:or(2):true, 1:or(3):true

charts/clickstack/templates/hyperdx/service.yaml

Uncovered lines: none

Uncovered branches: 14:default:fallback, 9:with:empty

charts/clickstack/templates/hyperdx/serviceaccount.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/mongodb/community.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/mongodb/password-secret.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/otel-collector/custom-config.yaml

Uncovered lines: none

Uncovered branches: none

Merging main applied #316's v1.9.0 pin and Dependabot ignore on top of this
branch. v1.9.0 ignores the v2 input names and emits hasChangesets, so the
has-changesets checks would skip chart-releaser and the GHCR push.
@jordan-simonovski
jordan-simonovski enabled auto-merge (squash) November 18, 2026 00:43
@jordan-simonovski
jordan-simonovski merged commit 67b0159 into main Nov 18, 2026
12 checks passed
@jordan-simonovski
jordan-simonovski deleted the jordansimonovski/changesets-cli-v3 branch November 18, 2026 00:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants