Skip to main content
command CX Codex

publish-canvas — Claude Code command: release the Copilot canvas

publish-canvas ships the Copilot app canvas: version bump, tests, the canvas-v<X.Y.Z> tag, then the github/awesome-copilot listing update.

MIT ★ 110 updated 2026-10-19

Install into Claude Code · Manually: put the files in place All methods and platforms ↓
.claude/commands/publish-canvas.md
Open on GitHub

What publish-canvas does

One run covers one release: the Copilot app canvas in apps/copilot-canvas/. It raises the version in plugin.json and package.json, runs npm run test:canvas and commits the result locally. Allowed tools stay narrow: git, gh, npm, node, plus file reads and edits.

Before anything leaves the machine it wants a clean tree on main and the layout their canvas gate reads: plugin.json at the plugin root, extension.mjs under com.github.copilot/extensions/speckit-companion/, assets/preview.png in place. A board importing a file from outside its own folder fails that check, so the fix lands before the tag. The QA gate in .claude/commands/release-qa.md runs first.

Then you see the version, the tag canvas-v<X.Y.Z>, the commit SHA and either the filled issue form or the plugins/external.json diff. Nothing is pushed until you answer with an explicit go, and an earlier yes or one given to /publish-all does not carry over. Only canvas-v* belongs to the canvas: a bare v* ships the VS Code extension to the Marketplace. A pushed canvas tag stays where it is, since the listing pins it.

What it helps with

  • bump the canvas version in plugin.json and package.json in one go
  • tag the release commit and point the listing at its SHA
  • check the plugin layout before the tag reaches origin
  • edit the plugins/external.json entry through a pull request
  • keep the release commit local until you approve the push

Example prompts for the agent

  • Release the canvas: bump to 1.4.0 and show me what goes to awesome-copilot
  • Check the apps/copilot-canvas layout and tag canvas-v1.4.0, but don't push until I say go
  • Update our plugins/external.json entry to the new commit

How to install publish-canvas

Manually: put the files in place

.claude/commands/publish-canvas.md

Call it with /publish-canvas. For all projects use ~/.claude/commands/

Questions about publish-canvas

How do I install publish-canvas in Claude Code?

Place the command file at .claude/commands/publish-canvas.md, then call /publish-canvas from a session inside the repository.

What does publish-canvas do?

It walks the canvas release: version bump, npm run test:canvas, a local commit, the canvas-v<X.Y.Z> tag, then the awesome-copilot issue form on a first listing or a pull request on later updates.

Why a canvas-v* tag and not v*?

A bare v* tag publishes the VS Code extension to the Marketplace. The canvas listing pins canvas-v*, so a pushed one is never moved and a fix ships as a new version.

Source text

publish-canvas.md · MIT
---
allowed-tools: Bash(git *), Bash(gh *), Bash(npm *), Bash(node:*), Bash(mkdir *), Read, Edit, Write, AskUserQuestion
description: Release the GitHub Copilot app canvas (apps/copilot-canvas) by tagging it and pointing its github/awesome-copilot listing at the new commit
---

## Context

- Git status: !`git status --porcelain | head`
- Current branch: !`git branch --show-current`
- Canvas version: !`node -p "require('./apps/copilot-canvas/plugin.json').version"`
- Latest canvas tags: !`git tag --list 'canvas-v*' --sort=-version:refname | head -3`
- Our listing upstream: !`gh api repos/github/awesome-copilot/contents/plugins/external.json --jq .content | base64 -d | node -e "const e=JSON.parse(require('fs').readFileSync(0,'utf8')).find(p=>p.name==='speckit-companion');console.log(e?JSON.stringify(e.source)+' v'+e.version:'not listed')"`
- Our issues and pull requests upstream: !`gh search issues --repo github/awesome-copilot --author @me speckit-companion --limit 5`

## Your task

Release the **GitHub Copilot app canvas** (`apps/copilot-canvas/`). It is listed on [github/awesome-copilot](https://github.com/github/awesome-copilot) as an **external plugin**: the code stays in this repo, and their `plugins/external.json` names this repo, the path `apps/copilot-canvas`, a tag and a commit SHA. No file is copied into their repo. Their [contributing guide](https://github.com/github/awesome-copilot/blob/main/CONTRIBUTING.md#adding-external-plugins) sets the rules: read that section again on every run and follow it where it differs from this file.

The layout their checks read is `plugin.json` at the plugin root and the board in `com.github.copilot/extensions/speckit-companion/`, with `extension.mjs` at its root.

**Nothing leaves this machine before the user says go.** Steps 1 to 4 are local. The pushes and the submission are step 6.

### Steps

0. **QA gate.** Apply the Release gate in `.claude/commands/release-qa.md`. If it does not pass, stop and tell the user to run `/release-qa`; continue only on their explicit override. Skip it when `/publish-all` already ran it in its preflight.
1. **Preflight.** The working tree is clean and the branch is `main`, or abort.
2. **Version.** Ask for the new version, showing the current one; a first listing may keep it. Skip the question when `/publish-all` passed one in. Their site lists the `version`, so an update with the old number looks like no update.
3. **Bump and build.** Set `version` in `apps/copilot-canvas/plugin.json` and `apps/copilot-canvas/package.json`, run `npm run test:canvas` (it rebuilds `vendor/` first), and commit `apps/copilot-canvas/` locally as `chore(canvas): release v<X.Y.Z>`. Do not push yet.
4. **Check the layout** their canvas gate reads, at the commit about to be tagged:
   ```bash
   P=apps/copilot-canvas
   git cat-file -e "HEAD:$P/plugin.json" && git cat-file -e "HEAD:$P/com.github.copilot/extensions/speckit-companion/extension.mjs" && git cat-file -e "HEAD:$P/assets/preview.png" && echo layout ok
   git grep -n -E "from '\.\./|import\('\.\./" HEAD -- "$P/com.github.copilot" ; echo "(no line above: the board imports nothing outside its folder)"
   ```
   Their gate fails a board that imports a file outside its own folder, so a hit on the second line is fixed here first.
5. **Show and wait.** Show the user what will be sent: the version, the tag `canvas-v<X.Y.Z>`, the SHA of the release commit, and either the filled issue form (first listing) or the `plugins/external.json` diff (update). Then stop until the user answers with an explicit go. A go from earlier in the conversation, or one given to `/publish-all` for the release as a whole, does not count.
6. **Send**, only after the go:
   ```bash
   V=<X.Y.Z>
   git push origin main
   git tag -a "canvas-v$V" -m "Copilot canvas v$V" && git push origin "canvas-v$V"
   SHA=$(git rev-parse "canvas-v$V^{commit}")
   ```
   - **Not listed yet:** open their [external plugin issue form](https://github.com/github/awesome-copilot/issues/new?template=external-plugin.yml) with the name `speckit-companion`, the description from `plugin.json`, the repository `alfredoperez/speckit-companion`, the path `apps/copilot-canvas`, the ref `canvas-v$V`, the SHA, the version, `MIT`, the author, the homepage and the keywords from `plugin.json` (`canvas` must be one). A pull request that adds a new entry to `plugins/external.json` is rejected: the form is the only way in. Their bots answer on the issue; after a fix here, tag again and comment `/rerun-intake`.
   - **Already listed:** an update is a pull request that edits our entry in `plugins/external.json`: `version`, `source.ref` and `source.sha`, nothing else. Branch from their `main` in the checkout under the sandbox root (`. .claude/sandboxes-env.sh`, then `$SANDBOXES_DIR/awesome-copilot`), run their `npm ci && npm start` so the generated files follow, push to the fork and open the pull request titled `Update SpecKit Companion canvas to v<X.Y.Z>`.
7. **Report** the issue or pull request URL, the `canvas-v<X.Y.Z>` tag and SHA, the labels their bots set (`ready-for-review` or `requires-submitter-fixes`), and how people install it once listed: from **Customize → Canvas** in the Copilot app.

### Guardrails

- If the user declines at step 5, the release commit stays local and unpushed. Say so, and leave it for them to push or drop.
- The only tag this command creates is `canvas-v*`. A bare `v*` tag publishes the VS Code extension to the Marketplace.
- A pushed `canvas-v*` tag is never moved: their listing pins it. A fix gets a new version and a new tag.
- `assets/preview.png` keeps that exact name and path: `plugin.json` names it as the logo, and it is the listing card.
- Approval is theirs. Never ping a maintainer, and never approve, merge or close anything upstream.

© alfredoperez · MIT · alfredoperez/speckit-companion

Similar slash commands

All slash commands for Git and GitHub →

From the same set83

The whole set →
publish-mod publish-mod releases the Claude Code mod through the repository marketplace and prepares the Anthropic directory handoff for the user. CX Codex +1 ★ 110repo stars speckit.companion.mark-complete speckit.companion.mark-complete marks the active spec as completed via write-context.py. Handy when you want to close a spec by hand instead of running a full converge. CX Codex +1 ★ 110repo stars speckit.constitution speckit.constitution updates the project constitution template in .specify/memory/constitution.md and aligns dependent specification templates. CX Codex GP ChatGPT ★ 110repo stars bench-run-all The bench-run-all command runs one benchmark size across three cells, drives the agent steps, then judges and captures the results. It is built for Speckit pipeline comparisons. CX Codex +1 ★ 110repo stars bench-replay The bench-replay command for Claude Code and Codex replays one pipeline step from a saved stage and grades the effect of a change. CX Codex +1 ★ 110repo stars speckit.tasks The speckit.tasks prompt turns feature design documents into a dependency-ordered tasks.md, grouped by user story. Use it to prepare an implementation plan from an existing spec. CX Codex GP ChatGPT ★ 110repo stars changelog-entry changelog-entry is a Claude Code command that writes a changelog entry from a PR or current diff and chooses its file and format. Run it with a PR number or no argument. CX Codex +1 ★ 110repo stars eval-speckit-extension eval-speckit-extension is a Claude Code skill that tests speckit-extension against a completed spec, verifying lifecycle hooks and .spec-context.json timestamps. CX Codex +1 ★ 110repo stars

Project sponsors

Companies that keep this analytics open