Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Version File] Remove assumption that canary and next should be snapshots #2467

Merged
merged 6 commits into from
Jul 17, 2024

Conversation

sugarmanz
Copy link
Collaborator

@sugarmanz sugarmanz commented Jul 12, 2024

What Changed

Remove the assumption that canary and next publishes should be done as snapshots. This is still the default, but you can now override the args to use when invoking the publishScript.

Why

It's better to make less assumptions to provide more fine grain control of what consumers can do during publishing for different release types.

Todo:

  • Add tests
  • Add docs

Change Type

Indicate the type of change your pull request is:

  • documentation
  • patch
  • minor
  • major

🐤 Download canary assets:

auto-linux--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.gz
auto-macos--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.gz
auto-win.exe--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.gz

📦 Published PR as canary version: under canary scope @auto-canary@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0

✨ Test out this PR locally via:

npm install @auto-canary/bot-list@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/auto@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/core@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/package-json-utils@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/all-contributors@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/brew@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/chrome@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/cocoapods@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/conventional-commits@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/crates@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/docker@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/exec@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/first-time-contributor@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/gem@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/gh-pages@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/git-tag@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/gradle@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/jira@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/magic-zero@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/maven@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/microsoft-teams@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/npm@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/omit-commits@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/omit-release-notes@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/pr-body-labels@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/protected-branch@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/released@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/s3@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/sbt@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/slack@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/twitter@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/upload-assets@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/version-file@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
npm install @auto-canary/vscode@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
# or 
yarn add @auto-canary/bot-list@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/auto@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/core@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/package-json-utils@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/all-contributors@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/brew@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/chrome@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/cocoapods@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/conventional-commits@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/crates@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/docker@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/exec@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/first-time-contributor@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/gem@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/gh-pages@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/git-tag@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/gradle@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/jira@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/magic-zero@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/maven@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/microsoft-teams@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/npm@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/omit-commits@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/omit-release-notes@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/pr-body-labels@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/protected-branch@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/released@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/s3@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/sbt@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/slack@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/twitter@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/upload-assets@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/version-file@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0
yarn add @auto-canary/vscode@11.2.0--canary.2467.bb9bf1e8d1186bc73fa8deffb2f661a893697f58.0

@sugarmanz sugarmanz added the minor Increment the minor version when merged label Jul 12, 2024
@sugarmanz
Copy link
Collaborator Author

I guess this would be a breaking change with how the publish script is invoked for canary and next. We could change the strategy to derive these values from config options and default to snapshot if not provided to preserve existing behavior. If we do that, we'd probably want the next major to change the options defaults to just the release type names.

@sugarmanz sugarmanz merged commit f4dcb98 into main Jul 17, 2024
8 checks passed
@sugarmanz sugarmanz deleted the version-file/publish-script-args branch July 17, 2024 01:35
Copy link

🚀 PR was released in v11.2.0 🚀

@github-actions github-actions bot added the released This issue/pull request has been released. label Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor Increment the minor version when merged released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants