Skip to content

GitHub

AlphaBase can run inside GitHub Actions to triage issues, review pull requests, and implement changes in isolated branches. This integration currently requires access to the AlphaBase Action repository and an approved release commit. It is not a verified public installation path.

Quick Setup

Obtain the reviewed 40-character Action commit SHA and approved published runtime version from your deployment operator, then run:

Terminal window
export ALPHABASE_GITHUB_ACTION_REF='<reviewed-40-character-commit-sha>'
export ALPHABASE_GITHUB_RUNTIME_VERSION='<approved-published-version>'
alphabase github install

The installer stops if either value is missing or malformed. It writes a workflow pinned to the supplied Action commit and runtime version. Confirm that your repository’s Actions runner can read both before enabling comment triggers.

Manual Setup

  1. Install the approved AlphaBase GitHub App on the target repository or organization.
  2. Generate .github/workflows/alphabase.yml with the installer after setting the reviewed Action commit SHA and approved runtime version.
  3. Review the generated event filters, repository permissions, and action ref.
  4. Add the required provider key in GitHub Secrets. The default App/OIDC flow does not require a separate GitHub token secret.

The action input model is required. agent is optional. Keep provider credentials in GitHub Secrets and avoid granting write permissions to untrusted comment or fork events. A workflow file is an example of integration wiring, not evidence that the Action or runtime is publicly available.

Session sharing is off by default, including for public repositories. Set the Action’s share input to "true" only after reviewing the session content and the deployment’s retention and revocation policy. See Data Handling.

Supported Trigger Patterns

  • issue comments
  • pull request review comments
  • pull request events
  • issue events
  • scheduled runs
  • manual workflow_dispatch

For non-comment triggers (schedule, issues, pull_request, workflow_dispatch), provide a prompt in workflow inputs.

Security Checklist

  1. Use least-privilege workflow permissions.
  2. Keep API keys only in GitHub Secrets.
  3. Use protected branches and required reviews.
  4. Restrict which events can write to the repository.
  5. Use staging repos first before production rollout.
  1. Start with read-only review tasks.
  2. Enable write/PR automation after confidence.
  3. Add scheduled maintenance tasks later (dependency checks, TODO sweeps, docs drift checks).

See Launch Gates and Troubleshooting.