chore: add changeset for v1.0.5 changes#7
Conversation
Replace the manual version bump + GitHub release trigger workflow with changesets, so version bumps and npm publishing are handled automatically via a "Version Packages" PR. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Add test step to release.yml before publishing (Codacy + Copilot review) - Restore prepublishOnly as safety net for local publishes (Codacy + Copilot review) - Set NPM_CONFIG_PROVENANCE=true to preserve provenance signing (Copilot review) - Update README CI/CD section with new changesets workflow - Add versioning/changesets section to AGENTS.md with agent responsibilities - Add agent self-documentation guidelines to AGENTS.md - Update SPECS/deployment.md to reflect new release workflow Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
There was a problem hiding this comment.
Pull Request Overview
While this PR successfully establishes the changesets infrastructure and release workflows, there is a critical blocker: the changeset file uses the incorrect package name ('codacy-cloud-cli' instead of the scoped '@codacy/codacy-cloud-cli'), which will cause the release automation to ignore the requested version bump.
Additionally, there is an inconsistency in the Node.js versioning strategy. Although the engine requirement was bumped to Node 20, the CI matrix still includes Node 18. These issues should be resolved to ensure the release process and environment validation are reliable and aligned with the project's new standards.
About this PR
- Systemic Inconsistency: The transition to Node 20 is incomplete. Ensure all references in GitHub Actions matrices and deployment specifications are aligned with the new engine requirement in package.json to avoid testing against unsupported runtimes.
1 comment outside of the diff
.github/workflows/ci.yml
line 15🟡 MEDIUM RISK
Suggestion: The CI matrix includes Node.js 18, which is below the new minimum requirement of Node.js 20. Update the matrix to ensure the code is only validated against supported runtimes.node-version: [20, 22]
Test suggestions
- Verify that the 'changeset-check' job correctly identifies new .md files in the .changeset directory (excluding README.md).
- Verify that the release workflow executes 'npm run update-api', 'npm run build', and 'npm test' before attempting a publish.
- Confirm the changeset file correctly targets 'codacy-cloud-cli' for a 'minor' version bump.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
| @@ -0,0 +1,13 @@ | |||
| --- | |||
| "codacy-cloud-cli": minor | |||
There was a problem hiding this comment.
🔴 HIGH RISK
The package name in the changeset header must match the '@codacy/codacy-cloud-cli' name defined in package.json.
| "codacy-cloud-cli": minor | |
| "@codacy/codacy-cloud-cli": minor |
There was a problem hiding this comment.
Good catch — the package name must match the scoped name in package.json. Fixed to @codacy/codacy-cloud-cli.
🤖 Generated by /pr-fixup command
| - name: Check for changesets | ||
| run: | | ||
| # Count .changeset/*.md files added/modified in this PR compared to the base branch | ||
| CHANGESETS=$(git diff --name-only origin/${{ github.base_ref }}...HEAD -- '.changeset/*.md' ':!.changeset/README.md' | wc -l) |
There was a problem hiding this comment.
🟡 MEDIUM RISK
Filter the git diff to only count added or modified files to ensure a new changeset is actually provided.
| CHANGESETS=$(git diff --name-only origin/${{ github.base_ref }}...HEAD -- '.changeset/*.md' ':!.changeset/README.md' | wc -l) | |
| CHANGESETS=$(git diff --name-only --diff-filter=AM origin/${{ github.base_ref }}...HEAD -- '.changeset/*.md' ':!.changeset/README.md' | wc -l) |
There was a problem hiding this comment.
Sensible hardening — added --diff-filter=AM to only count added/modified changeset files.
🤖 Generated by /pr-fixup command
| - **Pre-publish:** `prepublishOnly` runs `npm run build` using `tsconfig.build.json` | ||
| - **Engines:** requires Node.js >= 18 | ||
| - **Pre-publish:** `prepublishOnly` runs `npm run update-api && npm run build` as a safety net for local publishes | ||
| - **Engines:** requires Node.js >= 20 |
There was a problem hiding this comment.
⚪ LOW RISK
Suggestion: Since you are bumping the required Node version to 20, update the test matrix in .github/workflows/ci.yml to remove Node 18, as it is no longer supported by the package engines.
There was a problem hiding this comment.
Valid — removed Node 18 from the CI matrix to align with the engines: { node: ">=20" } requirement in package.json.
🤖 Generated by /pr-fixup command
There was a problem hiding this comment.
Pull request overview
This PR finalizes the repository’s move to a changesets-based release process by adding the required changesets configuration, updating CI to enforce changesets on PRs, and documenting the new release workflow. It also adds a changeset intended to capture the cumulative user-facing changes since v1.0.5.
Changes:
- Add changesets configuration + release workflow (
release.yml) and remove the old GitHub-release-triggered publish workflow. - Enforce “every PR must include a changeset” via a new
changeset-checkCI job. - Update docs/specs to describe the new versioning and publishing process, and add a “since v1.0.5” changeset entry.
Reviewed changes
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
SPECS/deployment.md |
Updates CI/release specification to reflect changesets-based workflow and secrets. |
README.md |
Updates CI/CD documentation to describe changesets-based publishing steps. |
package.json |
Adds changesets-related npm scripts and devDependencies. |
package-lock.json |
Locks changesets dependencies and transitive packages. |
AGENTS.md |
Documents new agent responsibilities around changesets and self-documenting changes. |
.github/workflows/release.yml |
Adds changesets-driven release workflow for version PR creation and publishing. |
.github/workflows/publish.yml |
Removes deprecated “publish on GitHub release” workflow. |
.github/workflows/ci.yml |
Adds changeset-check job to require a non-empty changeset per PR. |
.changeset/README.md |
Adds changesets-generated README. |
.changeset/fresh-spoons-build.md |
Adds a changeset describing changes since v1.0.5. |
.changeset/config.json |
Adds changesets configuration (changelog, baseBranch, access, etc.). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Fix scoped package name in changeset header (@codacy/codacy-cloud-cli) - Add --diff-filter=AM to changeset check CI job - Remove Node 18 from CI matrix to match engines >= 20 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary
minorversion bump when the changesets release PR is createdTest plan
🤖 Generated with Claude Code