Add canary release workflow 🐥

[sndrs]

What are you changing?

Adds a canary release option to PRs.

Why?

So we can test packages in external consumer codebases (@guardian/transparency-consent do this a lot, so it's needed for #1128).

How does it work?

It is based heavily on similar workflows in guardian/commercial#797 and guardian/consent-management-platform#849 (but with some slight differences):

1. adding the 🐥 Canaries label to a PR will trigger the release of canary versions of all packages with waiting changesets¹
2. while the label is present, pushing changes to the PR head branch will also release a new set of canaries (so you don't have to remove and add it continually)
3. removing the label will stop new releases (until you add it back)

Demo

You can see it running on this PR from #1178 (comment) onwards.

Footnotes

1. This is maybe not expected, but also it's not obvious how you'd get round this. How do you know which package with unreleased changes the user wants to test? It feels like overkill but I think it kind of makes sense. ↩

[changeset-bot]

⚠️ No Changeset found

Latest commit: 9530683

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]

Tip

Once this PR is ready to go, add the run_chromatic label to run the Chromatic tests.

This saves us a lot of money by not running the tests before we need them.

[github-actions]

Note

The following canaries were published to NPM:

• @guardian/[email protected]

🐥

[joecowton1]

nice work!

[sndrs]

currently this adds all releases to git, its possible this may change changesets/action#141 (which would be great)