Project board sync
Your project inherits .github/workflows/sync-github-project.yml from NuxtStart. It puts two kinds
of cards on a GitHub Project board:
| Card | Added when | Removed when |
|---|---|---|
| Issue | The issue gets a milestone | The milestone goes |
| Renovate's pull request | Renovate opens the pull request | Never, the board keeps it |
Milestone Project Sync handles issues. A Renovate pull request lands in whichever column your board's Item added to project workflow sets.
The workflow points at NuxtStart's board and has no token, so every run fails until you either remove it or point it at your own board.
flowchart LR
I["Your project inherits<br/>the workflow"] --> Q{"Do you track<br/>work on a board?"}
Q -- "no" --> D["Delete the file"]
Q -- "yes" --> P["Point it at your board<br/>and add a token"]
If you don't need it
Delete the file:
git rm .github/workflows/sync-github-project.yml
Point it at your board
Set your board
Open your board. Its URL reads https://github.com/users/<owner>/projects/<number>, or
/orgs/<owner>/ for a board an organization owns. Set both values in the workflow's top-level
env: block:
| Variable | Value |
|---|---|
PROJECT_OWNER | <owner> from the URL |
PROJECT_NUMBER | <number> from the URL |
Add the token
Create the token and store it as the PROJECT_PAT secret, following
Token in the action's README. It lists
the scopes and the gh secret set command.
Check it works by adding a milestone to an issue: its card appears on the board within a minute, and the run shows in the repository's Actions tab. Behaviour in the README covers what happens on removal and to issues that had a milestone already.
