Repository navigation
feat(ENG-15913): release a new major version of the action for a new CLI major version - #56
Draft
cloudsmith-iduffy wants to merge 3 commits into
Draft
cloudsmith-iduffy wants to merge 3 commits into
cloudsmith-iduffy wants to merge 3 commits into
Conversation
The CLI release dispatch sends every new Cloudsmith CLI version. A 2.0.0 release would pin the v3 default cli-version to a breaking CLI version. The bump script now ignores a CLI version with a different major version. It prints nothing and changes no files, as for a version that is already pinned. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain for the change intended to prevent automated CLI bumps across major versions.
No open issues 🎉
What changed in this PR
Prevents automated CLI bumps from introducing a breaking CLI major version into the action’s existing major release, keeping @v3 on Cloudsmith CLI 1.x.
Changes:
- Skips versions whose major differs from the pinned default, exiting successfully without stdout or file changes.
- Adds a regression test for a CLI 2.0.0 release.
- Documents the guard and adds an unreleased changelog entry.
| File | Description |
|---|---|
scripts/test-bump-cli-version.sh |
Checks that CLI 2.0.0 produces no stdout or file changes. |
scripts/bump-cli-version.sh |
Adds the major-version guard and updates its header comment. |
CONTRIBUTION.md |
Documents that cross-major CLI releases are ignored. |
CHANGELOG.md |
Records the fix under [Unreleased]. |
Review effort: Balanced
* origin/master: ci: use the standard cloudsmith-bot secret names (#57)
…CLI major version Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
A new CLI major version now gets a new major version of the action. When CLI 2.0.0 ships, the action releases
v4with CLI 2.0.0, and@v3stays on CLI 1.x. CLI 2.0.0 is a breaking release. Without this PR, its release would pin the@v3default to 2.0.0 and put a breaking change insidev3.Each CLI release sends a
cloudsmith-cli-releaseevent to this repository (cloudsmith-io/cloudsmith-cli#627).scripts/bump-cli-version.shthen moves the default and adds aCHANGELOG.mdsection. Today the section is always a patch or minor release. This PR makes it a major release when the CLI major version changes.CLI 1.32.0 ships
bump-cli-version.sh 1.32.0moves the default to 1.32.0 and adds aCHANGELOG.mdsection, as before. This PR adds an[Unreleased]entry, so that section is a minor release of the action, 3.3.0.CLI 2.0.0 ships
bump-cli-version.sh 2.0.0finds a different major version from the pinned default. It pins 2.0.0, and adds a 4.0.0 section toCHANGELOG.md.CHANGELOG.mdonmaster, sorelease.ymlruns. It creates the v4.0.0 release, and creates the floatingv4tag, because nov4tag exists yet.@v3stays on the last 3.x release, which pins CLI 1.x.CLI 1.40.3 ships after 2.0.0
1.40.3 is older than the pinned 2.0.0, so the script changes nothing.
@v3gets no more CLI bumps.An older CLI release ships
The script changes nothing, as before.
Other changes
CONTRIBUTION.mddescribes the major release.CHANGELOG.mdhas the[Unreleased]entry.Type of Change
Additional Notes
ENG-15913.
Testing
bash scripts/test-bump-cli-version.shpasses.bash -nandshellcheck --severity=stylepass on both bump scripts.bump-cli-version.sh 2.0.0pins 2.0.0, and adds a 4.0.0 section that includes the new[Unreleased]entry.bump-cli-version.sh 1.32.0adds a 3.3.0 section that includes the new[Unreleased]entry.bump-cli-version.sh 1.40.3prints nothing and changes no files.Still to do before this PR leaves draft
cli-version: 1.installer/, and update thecli-versioninput description.🤖 Generated with Claude Code