Examples

This page provides concrete examples: a full issue workflow, optional inputs for assignees and projects, and example labels and branch names.

Full issue workflow

Example .github/workflows/copilot_issue.yml with common inputs:

name: Copilot - Issue

on:
  issues:
    types: [opened, reopened, edited, labeled, unlabeled, assigned, unassigned]

jobs:
  copilot-issues:
    name: Copilot - Issue
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4

      - uses: vypdev/copilot@v2
        with:
          token: ${{ secrets.PAT }}
          project-ids: ${{ vars.PROJECT_IDS }}
          desired-assignees-count: 1
          branch-management-launcher-label: branched
          main-branch: main
          development-branch: develop
          feature-tree: feature
          bugfix-tree: bugfix
          hotfix-tree: hotfix
          release-tree: release
          opencode-model: ${{ vars.OPENCODE_MODEL }}
          ai-ignore-files: build/*
          debug: ${{ vars.DEBUG }}

• token is required. Use a fine-grained PAT with repo and project permissions (see Authentication).
• project-ids: Comma-separated project IDs so issues (and later PRs) are linked to boards.
• desired-assignees-count: Number of assignees (e.g. 1).
• branch-management-launcher-label: Add this label (e.g. branched) to trigger branch creation for feature/bugfix/docs/chore.
• main-branch / development-branch: Match your repo (e.g. main and develop).
• *-tree: Branch prefixes (e.g. feature/123-title). Omit if you keep defaults.

Example: branch-management-always

Create branches as soon as the issue has a type label (no launcher label):

- uses: vypdev/copilot@v2
  with:
    token: ${{ secrets.PAT }}
    project-ids: ${{ vars.PROJECT_IDS }}
    branch-management-always: true

Then opening an issue with label feature creates the branch immediately.

Example labels on an issue

Example branch names

Assuming defaults (feature-tree: feature, development-branch: develop):

Deploy workflow filenames

If you use release or hotfix and the deploy label, the action dispatches a workflow by filename. Defaults:

• release-workflow: release_workflow.yml
• hotfix-workflow: hotfix_workflow.yml

Your .github/workflows/ must contain files with these exact names (or pass the correct names in the action inputs). Example:

# In copilot_issue.yml (or wherever you call Copilot for issues)
- uses: vypdev/copilot@v2
  with:
    token: ${{ secrets.PAT }}
    release-workflow: release_workflow.yml
    hotfix-workflow: hotfix_workflow.yml

Next steps

• Workflow setup — Events and what runs when.
• Branch management — Launcher and naming in detail.
• Configuration — All issue-related inputs.