feat: switch to changesets release PR workflow - #951
Open
kdaviduik wants to merge 1 commit into
Open
Conversation
Contributor
Author
kdaviduik
changed the title
kdaviduik
force-pushed
the
03-13-chore_delete_deploying.md
branch
from
March 14, 2026 22:53
018b0c0 to
c6173bc
Compare
kdaviduik
changed the base branch from
graphite-base/951
to
enable-auto-changelog
March 14, 2026 22:53
This was referenced Mar 14, 2026
kdaviduik
force-pushed
the
03-13-chore_delete_deploying.md
branch
from
March 15, 2026 02:39
c6173bc to
215a2cc
Compare
kdaviduik
commented
Mar 18, 2026
|
|
||
| If your PR doesn't need a new npm release (docs-only changes, test updates, CI changes, etc.), just don't include a changeset. No changeset = no release PR = no npm publish. | ||
|
|
||
| ### Rollback (update `latest` CDN version) |
Contributor
Author
There was a problem hiding this comment.
It's extremely rare that we'd need/want to do this, but this was in the old DEPLOYING.md and is helpful to have just in case, especially the info like how to purge the CDN cache
kdaviduik
commented
Mar 18, 2026
| @@ -1,29 +1,31 @@ | |||
| name: Release new NPM version | |||
| name: Release | |||
Contributor
Author
There was a problem hiding this comment.
Overall this is very similar to Hydrogen's release.yml workflow
kdaviduik
force-pushed
the
03-13-chore_delete_deploying.md
branch
from
March 18, 2026 19:01
215a2cc to
5ebe7c7
Compare
kdaviduik
commented
Aug 14, 2026
| "fixed": [], | ||
| "linked": [], | ||
| "access": "restricted", | ||
| "access": "public", |
Contributor
Author
There was a problem hiding this comment.
Must be public since this is a public package on npm, docs
kdaviduik
force-pushed
the
03-13-chore_delete_deploying.md
branch
from
August 22, 2026 00:08
5ebe7c7 to
e8de275
Compare
kdaviduik
commented
Aug 22, 2026
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
| with: | ||
| fetch-depth: 1 | ||
| fetch-depth: 0 |
Contributor
Author
There was a problem hiding this comment.
Why
fetch-depth: 0instead of the default1?
fetch-depth: 1 (the checkout action's default) does a shallow clone — only the latest commit, no history, no tags. fetch-depth: 0 fetches the entire git history including all branches and tags.
This is required here because the changesets/action step (changeset version + changeset publish) depends on:
- Git tags — Changesets uses tags to determine which version to publish and to create GitHub releases. A shallow clone doesn't fetch them.
- Full commit history — When generating the release PR, Changesets inspects commits since the last release to build changelog entries and determine which packages changed.
With the default fetch-depth: 1, you'd hit errors like "could not find tag" and end up with empty/incomplete changelogs.
kdaviduik
marked this pull request as ready for review
August 22, 2026 00:11
Replace the direct-publish npm release workflow with the two-mode changesets/action pattern: pending changesets create a release PR titled "[ci] release"; merging it triggers npm publish. Why: the previous workflow published to npm immediately on PR merge. This made it impossible to batch multiple changes from separate PRs in a single npm release, and also meant that authors who didn't realize that PR merge = release could accidentally publish to npm a change that isn't ready for release. The release PR pattern creates an intermediate PR showing exactly what will be published before it goes out.
kdaviduik
force-pushed
the
03-13-chore_delete_deploying.md
branch
from
August 22, 2026 00:30
e8de275 to
1873514
Compare
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
1 participant
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.
Part of https://github.com/Shopify/developer-tools-team/issues/1195
Summary
DEPLOYING.md(info is now in CONTRIBUTING.md instead))CLAUDE.mdandAGENTS.mdas symlinks toCONTRIBUTING.mdso that we have a single source of truth for all of this information and agents automatically "see" itnpm-release.ymlfor the changesets release PR pattern: pending changesets create a[ci] releasePR; merging that PR triggers npm publishWhy
The previous workflow published to npm immediately on PR merge. This made it extremely un-ergonomic to batch multiple merchant-facing changes in a single release, and required workarounds (like adding
[DOCS]to the PR title) to avoid releasing a new Buy Button JS version when there were zero code changes. The release PR pattern (used by Hydrogen and many Shopify repos) creates an intermediate PR showing exactly what will be published and is the more modern, preferred way of managing releases.External prerequisite
SHOPIFY_GH_ACCESS_TOKENhas been provisioned via github-actions-access-provider#2613