canary

Source excerpt starting at line 1.

1---2name: canary3description: Finds or publishes a pkg.pr.new canary release for a Storybook branch. Use when the user wants the canary package specifier for a branch or needs to trigger the canary workflow manually.4allowed-tools: Bash5---6 7# Find Or Publish Canary Release8 9Use this skill to get a branch-specific canary build from `pkg.pr.new`.10 11Canary publishes are driven by the `publish-canary.yml` workflow.12 13Automatic canary publishes:14 15- Every push to `next`16- In-repo PRs labeled `ci:canary` (a human must apply that label). While it remains, every push to the PR republishes. The label does nothing on fork PRs.17 18## Version string19 20The canary version string is constructed like this:21 22```text23storybook@https://pkg.pr.new/storybook@<SHA>24```25 26Replace `<SHA>` with the short commit SHA (first 7 characters). Compact URLs (`https://pkg.pr.new/storybook@<SHA>`) resolve to the same tarball as the owner/repo form. The pkg.pr.new dashboard is always `https://pkg.pr.new/~/storybookjs/storybook`.27 28## Check whether a canary already exists29 30```bash31SHA=$(git rev-parse --short=7 HEAD)32curl -I "https://pkg.pr.new/storybook@$SHA"33```34 35An HTTP `200` status code means the canary already exists for that commit.36 37## Decision flow38 39Use this skill with the following if-then behavior.40 41### A. If the branch already has a PR with the `ci:canary` label42 43Do not trigger anything manually. Read the canary heading and install commands from the PR body. That section is the current run status and the most recent release.44 45```bash46BRANCH=$(git branch --show-current)47 48gh pr list \49	--repo storybookjs/storybook \50	--head "$BRANCH" \51	--state open \52	--json number,title,labels,url \53	--jq '.[] | select(any(.labels[]?; .name == "ci:canary"))'54```55 56```bash57gh pr view <NUMBER> --repo storybookjs/storybook --json body --jq .body58```59 60Use the heading and the `CANARY_RELEASE_SECTION` commands as-is. A follow-up workflow (`publish-canary-pr-body.yml`) writes those sections after publish finishes, including after a maintainer manual run.61 62Fork PRs never use path A. Use path C.63 64- **Released** — use the install commands from the body65- **Failed** — the heading links to pkg.pr.new; the failure comment links to the workflow run66- **Not run** — publish is still in progress, unlabeled, or the follow-up has not run yet67 68### B. If the in-repo branch does not have a PR with the `ci:canary` label69 70Trigger the canary workflow manually on the branch and watch it finish. It usually takes 5-10 minutes. You can also use the GitHub Actions UI: open `publish-canary.yml`, click "Run workflow", and select the branch. Optional inputs `pr`, `branch`, and `sha` must agree when more than one is set.71 72```bash73BRANCH=$(git branch --show-current)74 75gh workflow run --repo storybookjs/storybook publish-canary.yml --ref "$BRANCH"76```77 78Find the new workflow run and watch it:79 80```bash81BRANCH=$(git branch --show-current)82 83RUN_ID=$(gh run list \84	--repo storybookjs/storybook \85	--workflow publish-canary.yml \86	--branch "$BRANCH" \87	--event workflow_dispatch \88	--json databaseId \89	--jq '.[0].databaseId')90 91gh run watch "$RUN_ID" --repo storybookjs/storybook92```93 94When it finishes successfully, read the canary heading from the PR body if a PR was updated. Otherwise construct the version string from the published SHA (the run's `headSha` is the workflow-source branch, which may differ when you passed `pr` or `sha`):95 96```bash97RUN_SHA=$(gh run view "$RUN_ID" --repo storybookjs/storybook --json jobs --jq '[.jobs[].steps[]?.name | select(startswith("canary-ref "))][0]' | sed -n 's/.*sha=\([0-9a-fA-F]\{7,40\}\).*/\1/p')98SHORT_SHA="${RUN_SHA:0:7}"99echo "storybook@https://pkg.pr.new/storybook@$SHORT_SHA"100```101 102### C. If the change is a fork PR103 104Do not add `ci:canary`. Dispatch the workflow from this repository with the PR number. The fork author does not need to do anything.105 106```bash107gh workflow run --repo storybookjs/storybook publish-canary.yml --ref next -f pr=<PR_NUMBER>108```109 110If you also pass `branch` or `sha`, they must be that PR's current head. A later push on the fork does not republish until you run the workflow again.111 112Optionally confirm the package is live:113 114```bash115curl -I "https://pkg.pr.new/storybook@$SHORT_SHA"116```117 118 119## Use the canary120 121For a new project:122 123```bash124npx --yes --allow-remote=all https://pkg.pr.new/create-storybook@<SHA>125```126 127For an existing project:128 129```bash130npx --yes --allow-remote=all https://pkg.pr.new/storybook@<SHA> upgrade131```132 133## Requirements134 135- You need `gh` CLI authenticated for `storybookjs/storybook`136- You need permission to run workflows in the repository for manual dispatch137- The canary workflow is `publish-canary.yml`138 139## Monitor progress140 141Workflow page:142 143- https://github.com/storybookjs/storybook/actions/workflows/publish-canary.yml144 145CLI:146 147```bash148gh run list --repo storybookjs/storybook --workflow publish-canary.yml149```150