Skip to content

docs: Add critical warning about reusable workflow references in SETUP_CHECKLIST #216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stranske merged 1 commit into from
Dec 27, 2025
Merged

docs: Add critical warning about reusable workflow references in SETUP_CHECKLIST #216

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/templates/SETUP_CHECKLIST.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,27 @@ curl -o .github/workflows/maint-sync-workflows.yml \
https://raw.githubusercontent.com/stranske/Travel-Plan-Permission/main/.github/workflows/maint-sync-workflows.yml
```

> **⚠️ CRITICAL: Fix reusable workflow references after copying!**
>
> The `agents-63-issue-intake.yml` file in the Workflows repo contains a LOCAL
> reference to `reusable-agents-issue-bridge.yml`. This works in Workflows but
> **will break in consumer repos** because the file doesn't exist locally.
>
> After copying, you MUST change line ~1171 from:
> ```yaml
> uses: ./.github/workflows/reusable-agents-issue-bridge.yml
> ```
> To the remote reference:
> ```yaml
> uses: stranske/Workflows/.github/workflows/reusable-agents-issue-bridge.yml@main
> ```
>
> **Alternative**: Copy from Template repo instead (already has correct reference):
> ```bash
> curl -o .github/workflows/agents-63-issue-intake.yml \
> https://raw.githubusercontent.com/stranske/Template/main/.github/workflows/agents-63-issue-intake.yml
> ```

### 4.2 Autofix Versions Configuration

> **Important**: Each repository maintains its own `autofix-versions.env` file
Expand Down Expand Up @@ -800,6 +821,7 @@ inputs:
2. **Missing commit status** — Keepalive checks for `Gate / gate` status to know when CI passes
3. **Wrong workflow name in trigger** — The `workflows:` array must match the exact workflow `name:` field
4. **Missing scripts** — Scripts are NOT automatically synced; they must exist in consumer repo
5. **Local reusable workflow references** — When copying `agents-63-issue-intake.yml` from Workflows, it has a LOCAL reference to `reusable-agents-issue-bridge.yml` that doesn't exist in consumer repos. Must change to remote reference: `stranske/Workflows/.github/workflows/reusable-agents-issue-bridge.yml@main`
Copy link

Copilot AI Dec 27, 2025

Choose a reason for hiding this comment

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

This line is excessively long (over 270 characters) and difficult to read. Consider breaking it into multiple lines or condensing the explanation since the full details are already documented in section 4.1b. The Common Mistakes section should be a quick reference with brief descriptions.

Suggested change
5. **Local reusable workflow references** — When copying `agents-63-issue-intake.yml` from Workflows, it has a LOCAL reference to `reusable-agents-issue-bridge.yml` that doesn't exist in consumer repos. Must change to remote reference: `stranske/Workflows/.github/workflows/reusable-agents-issue-bridge.yml@main`
5. **Local reusable workflow references** — `agents-63-issue-intake.yml` uses a local `reusable-agents-issue-bridge.yml`; in consumer repos update to remote `stranske/Workflows/.github/workflows/reusable-agents-issue-bridge.yml@main`

Copilot uses AI. Check for mistakes.

---

Expand Down
Loading