Skip to content

How-to

Send your roadmap to GitHub Issues and a Project board

Turn roadmap items into GitHub issues, and optionally keep a Project board's Status column in step with them.

What you'll do

Copy your roadmap items to GitHub Issues with one command. Items in backlog/, in-progress/ and done/ become issues; inbox/ and hold/ stay private. The copy is one way: the files in .aidlc/roadmap/ stay the source, and GitHub follows them. Moving cards on a Project board is an optional second part.

Steps

  1. Install the GitHub CLI and sign in. AIDLC uses its login and never asks for a token:

    gh auth login
    
  2. Preview what would change. This writes nothing:

    aidlc roadmap sync --dry-run
    

    It uses the repository your folder points at. To target another one, add --repo <owner/name>.

  3. Apply it:

    aidlc roadmap sync
    

    It shows the plan and asks before it writes. Run it again whenever items move — it updates labels, and closes an issue when its item reaches done/.

  4. Optional — move a Project board too. Save the workflow AIDLC ships into your repository:

    aidlc roadmap board-workflow > .github/workflows/aidlc-project-status.yml
    

    Then, in your repository's settings on GitHub:

    • Create a classic token with the project and read:org scopes (add repo if the repository is private). Store it as the repository secret AIDLC_PROJECT_TOKEN, with <your-github-token> as the value. Never paste it into a file you commit.
    • Set the repository variable AIDLC_PROJECT_NUMBER to your project's number — the digits in its URL.

    The top of the workflow file lists the Status columns it expects and how to rename them.

Check it worked

Open your repository's Issues tab on GitHub. You should see one issue per roadmap item in backlog/, in-progress/ and done/, each labelled aidlc. If you set up the board, move an item and run aidlc roadmap sync again: once the workflow run shows in your Actions tab, its card should be in the new column.