Skip to content

GitHub Setup

Create machine users or fine-grained tokens for the actors you enable and add the accounts as repository collaborators. Configure a named connector:

connectors:
  github-main:
    provider: github
    url: https://github.com
    externalUrl: https://github.com
    webhookSecret: {env: GITHUB_WEBHOOK_SECRET}
    actors:
      smithy:
        username: smithy-bot
        token: {env: SMITHY_GITHUB_TOKEN}
        git:
          name: Smithy
          email: smithy@users.noreply.github.com
      architect:
        username: architect-bot
        token: {env: ARCHITECT_GITHUB_TOKEN}
        git:
          name: Architect
          email: architect@users.noreply.github.com
defaults:
  vcs: github-main
  issueTracker: event.source
  actor: smithy

For GitHub Enterprise, set url to the instance root; the API path is derived by the connector. Add a JSON webhook with the configured secret and this payload URL:

https://<orchestrator-host>/webhooks/github-main

Enable issues, issue comments, pushes, pull requests, pull request reviews, review comments, and workflow runs. Configure the same connector webhook on the context repository.