Skip to content

feat(gh-aw): Create shared/squad.md bootstrap component #1613

Closed

Description

@bradygaster

shared/squad.md — Bootstrap Component

Part of #1612 (Squad Agentic Workflows epic).

Overview

The activation-job component that installs Squad CLI and bundles .squad/ + .github/agents/ into the agent job via ambient-folders. This is the foundation that all three sourcing modes depend on.

Design

engine:
  id: copilot
  agent: squad

ambient-folders:
  - ".squad"
  - ".github/agents"

activation:
  steps:
    - name: Install Squad CLI
      run: |
        SQUAD_VERSION="${SQUAD_CLI_VERSION:-latest}"
        npm install -g @bradygaster/squad-cli@$SQUAD_VERSION
    - name: Bootstrap squad context
      run: squad bootstrap --mode ${{ inputs.mode || "cast" }}

Key Requirements

  • Installs Squad CLI with configurable version via SQUAD_CLI_VERSION env var
  • Bundles .squad/ and .github/agents/ folders into agent job context via ambient-folders
  • Supports optional GitHub App token input for cross-org access (Connect mode)
  • In Connect mode: pulls remote squad files at activation time using squad-source config
  • Owned and maintained by us (references Peli's implementation in github/gh-aw as prior art)
  • Must be compatible with gh-aw's shared/ component resolution

File Location

workflows/shared/squad.md

Acceptance Criteria

  • shared/squad.md is valid gh-aw component syntax
  • Squad CLI installs successfully in activation job
  • SQUAD_CLI_VERSION variable controls installed version
  • .squad/ and .github/agents/ are available in agent job context
  • Optional github-app-token input works for cross-org scenarios
  • Connect mode pulls remote squad at activation time
  • Component can be referenced by squad.md workflow via standard gh-aw includes

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or improvementgh-awGitHub Agentic Workflows integration

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions