Skip to content

fix(cli): point runtime URLs and init templates at github/squad - #2412

Merged
tamirdresher merged 2 commits into
devfrom
squad/2404-cli-sdk-template-links
Nov 8, 2026
Merged

tamirdresher merged 2 commits into
devfrom
squad/2404-cli-sdk-template-links

Conversation

@tamirdresher

Copy link
Copy Markdown
Collaborator

What

Points user-facing CLI/SDK URLs, and the templates that squad init installs, at github/squad:

  • CLI/SDK URLs: the squad upgrade release URL, the .ai-team/ migration notice, the SDK's "please report it at" URL, and the state-backend docs link.
  • Templates: session-init-reference, gh-auth-isolation, pr-review-response, external-comms, tiered-memory, and github-multi-account. The github-multi-account skill no longer ties the repo to a named personal account; it checks which account has push access instead.

test/repo-links.test.ts guards these links.

Working as cli-dev (CLI Engineer).

Why

After the transfer, users were sent to the old repository for releases, issues, and docs. The templates also copied old-repository API paths into users' repos. The state-backend link pointed at docs/state-backends.md, a path that never existed, so it was already a 404.

Closes #2404

How

  • Only canonical .squad-templates/ files were edited. The 3 mirrors were synced with node scripts/sync-templates.mjs --sync, so template-sync keeps them byte-identical.
  • packages/squad-cli/src/cli/core/init.ts is a protected bootstrap file. Only one string changed, and no imports were added.
  • Kept as written:
    • bradygaster/squad#NNN references, including the link text in tiered-memory; only the URLs changed
    • source: provenance frontmatter
    • the npm scope
    • the Homebrew and WinGet lines in the release-process skill
    • the deprecated root index.cjs/cli.js messages about npx github:bradygaster/squad
  • No shared URL constant was added, because neither package has a natural home for one.

Size (>20 files): 31 files:

  • 11 hand edits: 4 source files, 6 canonical templates, and this repo's own github-multi-account skill
  • 18 synced mirror copies, 3 per template
  • a test and a changeset

Validation (branch on its own, Windows, Node 27):

Command Result
npx vitest run test/repo-links.test.ts test/template-sync.test.ts test/recast-identity-neutrality.test.ts test/state-backend.test.ts test/init-sdk.test.ts test/cli.test.ts 644 passed. 8 tests in cli, init-sdk, and state-backend timed out while other suites ran in parallel
Rerun of test/cli.test.ts test/init-sdk.test.ts test/state-backend.test.ts alone ✅ 3 files, 209 passed, 1 skipped
npm run lint ✅ passed
SKIP_BUILD_BUMP=1 npm run build ✅ passed
Red proof ✅ all 6 repo-links tests fail against the old content, naming 19 file:line hits

The other repo-move PRs are #2406, #2407, #2403, and #2405 (issues).


⚠️ Quick Check

  • If SDK/CLI source files changed: completed the applicable Changeset step below (npx changeset add / .changeset/*.md, direct CHANGELOG.md entry for maintainers, or skip-changelog label for no user-facing changes)

PR Readiness Checklist

The PR readiness bot will validate these automatically after push.
Check each item before requesting review. See CONTRIBUTING.md for full details.

Branch & Commit

  • Branch created from dev (not main)
  • Branch is up to date with dev (git fetch upstream && git rebase upstream/dev)
  • Verified diff contains only intended changes (git diff --cached --stat)
  • PR is not in draft mode (mark ready when checks pass)
  • Commit history is clean (squash fixups before review)

Build & Test

  • npm run build passes
  • npm test passes (all tests green): targeted suites above; the full suite runs in CI
  • npm run lint passes (type check clean)
  • npm run lint:eslint passes
  • For migration PRs (>20 files): include test output summary in PR description

Changeset

  • Changeset added via npx changeset add (if packages/squad-sdk/src/ or packages/squad-cli/src/ changed): .changeset/repo-move-github-squad-user-links.md
  • Or direct CHANGELOG.md entry (maintainers only — write-protected for external contributors)
  • Or skip-changelog label applied (if no user-facing changes)

Docs

Exports

  • package.json subpath exports updated (if new module): N/A, no new modules

Breaking Changes

None.

Waivers

None.

- The communications owner scans issues and discussions, drafts responses with the humanizer skill, and presents a review table for human approval.
- **Human review gate is mandatory** — the communications owner never posts autonomously.
- The communications owner scans issues and discussions, drafts responses with the humanizer skill, and presents a review table for human approval.
- **Human review gate is mandatory** — the communications owner never posts autonomously.
@github-actions

github-actions Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

🛫 PR Readiness Check

ℹ️ This comment updates on each push. Last checked: commit 49a4b0f

PR Scope: 📦🔧 Mixed (product + infrastructure)

⚠️ 4 item(s) to address before review

Status Check Details
❌ Single commit 2 commits — consider squashing before review
❌ Not in draft PR is still in draft — mark as ready for review when done
✅ Branch up to date Up to date with dev
❌ Copilot review No Copilot review yet — it may still be processing
✅ Changeset present Changeset file found
✅ Scope clean No .squad/ or docs/proposals/ files
✅ No merge conflicts No merge conflicts
✅ Copilot threads resolved No Copilot review threads
❌ CI passing 1 check(s) still running

Files Changed (31 files, +334 −163)

File +/−
.changeset/repo-move-github-squad-user-links.md +6 −0
.copilot/skills/github-multi-account/SKILL.md +11 −9
.squad-templates/session-init-reference.md +2 −2
.squad-templates/skills/external-comms/SKILL.md +1 −1
.squad-templates/skills/gh-auth-isolation/SKILL.md +2 −2
.squad-templates/skills/github-multi-account/SKILL.md +11 −9
.squad-templates/skills/pr-review-response/SKILL.md +10 −10
.squad-templates/skills/tiered-memory/SKILL.md +5 −5
packages/squad-cli/src/cli/core/init.ts +1 −1
packages/squad-cli/src/cli/upgrade.ts +1 −1
packages/squad-cli/templates/session-init-reference.md +2 −2
packages/squad-cli/templates/skills/external-comms/SKILL.md +18 −18
packages/squad-cli/templates/skills/gh-auth-isolation/SKILL.md +2 −2
packages/squad-cli/templates/skills/github-multi-account/SKILL.md +11 −9
packages/squad-cli/templates/skills/pr-review-response/SKILL.md +10 −10
packages/squad-cli/templates/skills/tiered-memory/SKILL.md +5 −5
packages/squad-sdk/src/config/init.ts +1 −1
packages/squad-sdk/src/state-backend.ts +1 −1
packages/squad-sdk/templates/session-init-reference.md +2 −2
packages/squad-sdk/templates/skills/external-comms/SKILL.md +18 −18
packages/squad-sdk/templates/skills/gh-auth-isolation/SKILL.md +2 −2
packages/squad-sdk/templates/skills/github-multi-account/SKILL.md +11 −9
packages/squad-sdk/templates/skills/pr-review-response/SKILL.md +10 −10
packages/squad-sdk/templates/skills/tiered-memory/SKILL.md +5 −5
templates/session-init-reference.md +2 −2
templates/skills/external-comms/SKILL.md +1 −1
templates/skills/gh-auth-isolation/SKILL.md +2 −2
templates/skills/github-multi-account/SKILL.md +11 −9
templates/skills/pr-review-response/SKILL.md +10 −10
templates/skills/tiered-memory/SKILL.md +5 −5
test/repo-links.test.ts +155 −0

Total: +334 −163


This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The review record identifies no remaining blockers after the canonical URL, template, and permission-based account-guidance updates were addressed.

No open issues 🎉

What changed in this PR

This pull request updates user-facing CLI/SDK URLs and squad init templates to use the repository’s new canonical location, github/squad, following the repository transfer. It also introduces repository-permission-based GitHub account guidance and regression coverage.

Changes:

  • Updated CLI and SDK release, migration, error-reporting, and state-backend documentation URLs.
  • Updated canonical templates and synchronized CLI, SDK, and root mirrors.
  • Added repository-link regression tests and a patch changeset.
  • Updated multi-account guidance to use repository push-permission checks; final review identified placeholder and rule-order issues in the canonical and repository-local copies.
File Description
test/​repo-links.test.ts Adds regression coverage for runtime URLs, template links, state-backend documentation, and account neutrality.
templates/​skills/​tiered-memory/​SKILL.md Synced tiered-memory issue links.
templates/​skills/​pr-review-response/​SKILL.md Synced GitHub API repository paths.
templates/​skills/​github-multi-account/​SKILL.md Synced permission-based account-selection guidance.
templates/​skills/​gh-auth-isolation/​SKILL.md Synced upstream repository examples.
templates/​skills/​external-comms/​SKILL.md Synced the example issue URL.
templates/​session-init-reference.md Synced release API and release-notes URLs.
packages/​squad-sdk/​templates/​skills/​tiered-memory/​SKILL.md SDK template mirror for tiered-memory links.
packages/​squad-sdk/​templates/​skills/​pr-review-response/​SKILL.md SDK template mirror for review-response API paths.
packages/​squad-sdk/​templates/​skills/​github-multi-account/​SKILL.md SDK template mirror for account-selection guidance.
packages/​squad-sdk/​templates/​skills/​gh-auth-isolation/​SKILL.md SDK template mirror for upstream repository examples.
packages/​squad-sdk/​templates/​skills/​external-comms/​SKILL.md SDK template mirror for the example issue URL.
packages/​squad-sdk/​templates/​session-init-reference.md SDK template mirror for release links.
packages/​squad-sdk/​src/​state-backend.ts Fixes the git-notes migration documentation link.
packages/​squad-sdk/​src/​config/​init.ts Updates the SDK template-drift reporting URL.
packages/​squad-cli/​templates/​skills/​tiered-memory/​SKILL.md CLI template mirror for tiered-memory links.
packages/​squad-cli/​templates/​skills/​pr-review-response/​SKILL.md CLI template mirror for review-response API paths.
packages/​squad-cli/​templates/​skills/​github-multi-account/​SKILL.md CLI template mirror for account-selection guidance.
packages/​squad-cli/​templates/​skills/​gh-auth-isolation/​SKILL.md CLI template mirror for upstream repository examples.
packages/​squad-cli/​templates/​skills/​external-comms/​SKILL.md CLI template mirror for the example issue URL.
packages/​squad-cli/​templates/​session-init-reference.md CLI template mirror for release links.
packages/​squad-cli/​src/​cli/​upgrade.ts Updates the CLI release URL.
packages/​squad-cli/​src/​cli/​core/​init.ts Updates the .ai-team/ migration notice URL.
.squad-templates/​skills/​tiered-memory/​SKILL.md Updates canonical tiered-memory issue links.
.squad-templates/​skills/​pr-review-response/​SKILL.md Updates canonical review-response API paths.
.squad-templates/​skills/​github-multi-account/​SKILL.md Adds permission-based account selection; its executable snippet still contains literal account placeholders, and an earlier owner-based rule can bypass the permission check.
.squad-templates/​skills/​gh-auth-isolation/​SKILL.md Updates canonical upstream repository examples.
.squad-templates/​skills/​external-comms/​SKILL.md Updates the canonical example issue URL.
.squad-templates/​session-init-reference.md Updates canonical release API and release-notes URLs.
.copilot/​skills/​github-multi-account/​SKILL.md Updates repository-local account guidance; its executable snippet still contains literal account placeholders.
.changeset/​repo-move-github-squad-user-links.md Records patch releases for the CLI and SDK packages.

Review effort: Lite (auto)

@tamirdresher
tamirdresher force-pushed the squad/2404-cli-sdk-template-links branch from 7155bf9 to d7f698b Compare November 8, 2026 14:27
@github-actions

github-actions Bot commented Nov 8, 2026

Copy link
Copy Markdown
Contributor

🟠 Impact Analysis — PR #2412

Risk tier: 🟠 HIGH

📊 Summary

Metric Count
Files changed 31
Files added 2
Files modified 29
Files deleted 0
Modules touched 6

🎯 Risk Factors

  • 31 files changed (21-50 → HIGH)
  • 6 modules touched (5-8 → HIGH)

📦 Modules Affected

copilot-config (1 file)
  • .copilot/skills/github-multi-account/SKILL.md
root (7 files)
  • .changeset/repo-move-github-squad-user-links.md
  • templates/session-init-reference.md
  • templates/skills/external-comms/SKILL.md
  • templates/skills/gh-auth-isolation/SKILL.md
  • templates/skills/github-multi-account/SKILL.md
  • templates/skills/pr-review-response/SKILL.md
  • templates/skills/tiered-memory/SKILL.md
squad-cli (8 files)
  • packages/squad-cli/src/cli/core/init.ts
  • packages/squad-cli/src/cli/upgrade.ts
  • packages/squad-cli/templates/session-init-reference.md
  • packages/squad-cli/templates/skills/external-comms/SKILL.md
  • packages/squad-cli/templates/skills/gh-auth-isolation/SKILL.md
  • packages/squad-cli/templates/skills/github-multi-account/SKILL.md
  • packages/squad-cli/templates/skills/pr-review-response/SKILL.md
  • packages/squad-cli/templates/skills/tiered-memory/SKILL.md
squad-sdk (8 files)
  • packages/squad-sdk/src/config/init.ts
  • packages/squad-sdk/src/state-backend.ts
  • packages/squad-sdk/templates/session-init-reference.md
  • packages/squad-sdk/templates/skills/external-comms/SKILL.md
  • packages/squad-sdk/templates/skills/gh-auth-isolation/SKILL.md
  • packages/squad-sdk/templates/skills/github-multi-account/SKILL.md
  • packages/squad-sdk/templates/skills/pr-review-response/SKILL.md
  • packages/squad-sdk/templates/skills/tiered-memory/SKILL.md
templates (6 files)
  • .squad-templates/session-init-reference.md
  • .squad-templates/skills/external-comms/SKILL.md
  • .squad-templates/skills/gh-auth-isolation/SKILL.md
  • .squad-templates/skills/github-multi-account/SKILL.md
  • .squad-templates/skills/pr-review-response/SKILL.md
  • .squad-templates/skills/tiered-memory/SKILL.md
tests (1 file)
  • test/repo-links.test.ts

This report is generated automatically for every PR. See #733 for details.

@github-actions

github-actions Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

🏗️ Architectural Review

Authoritative evidence: scanners from the PR base commit, posted by the default-branch workflow_run reporter.
Results for head commit 49a4b0fc39dcb39784c9b11bcda3ad6b6c5bccd1.

⚠️ Architectural review: 2 warning(s).

Severity Category Finding Files
🟡 warning bootstrap-area 1 file(s) in the bootstrap area (packages/squad-cli/src/cli/core/) were modified. These files must maintain zero external dependencies. Review carefully. packages/squad-cli/src/cli/core/init.ts
🟡 warning sweeping-refactor This PR touches 31 files (31 modified/added, 0 deleted). Large PRs are harder to review — consider splitting if possible. —

Automated architectural review — informational only.

Copilot AI added 2 commits November 8, 2026 20:42
- squad upgrade release URL, the .ai-team migration notice and the SDK's
  report URL
- state-backend docs link (also fixes a pre-existing 404)
- squad init templates: session-init-reference, gh-auth-isolation,
  pr-review-response, external-comms, tiered-memory, github-multi-account
- test/repo-links.test.ts guards user-facing links

Closes #2404

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…i-account

This PR replaced the hardcoded repo binding with a push-permission check,
but usage rule 3 still chose the alias by repo owner, and the Step 5
message to the user said the same, so the skill contradicted itself
(flagged in Copilot review). Point rule 3 at the permission check and
reword the Step 5 message to match.

Synced to the root, CLI and SDK template mirrors and the repo-local copy.

Refs #2404

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@tamirdresher
tamirdresher force-pushed the squad/2404-cli-sdk-template-links branch from d7f698b to 49a4b0f Compare November 8, 2026 18:42
@tamirdresher

Copy link
Copy Markdown
Collaborator Author

Added 49a4b0f after Copilot's review. The account-selection guidance in github-multi-account contradicted itself: this PR's new binding section picks the gh alias by push access, but usage rule 3 and the Step 5 message to the user still picked it by repo owner. Rule 3 now points at the push-access check, and the Step 5 message matches. The change is applied identically to the canonical skill and its 4 mirrors.

Validation: npx vitest run test/repo-links.test.ts test/template-sync.test.ts test/builtin-skills.test.ts: ✅ 426/426.

@tamirdresher
tamirdresher marked this pull request as ready for review November 8, 2026 18:55
@tamirdresher
tamirdresher merged commit e85b4d5 into dev Nov 8, 2026
33 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Repo move: update CLI/SDK runtime URLs and squad init templates to github/squad

4 participants