Skip to main content

​
Before you start

  • Sign in to your Peak workspace.
  • Be an owner of the GitHub organization.
  • Choose private repositories that are not forks, archived, or disabled.
  • Push at least one commit to each repository.

​
Connect an organization

  1. Open Runners.
  2. Choose Connect GitHub.
  3. Authorize Peak on GitHub.
  4. Install the Peak Runners GitHub App in your organization.
  5. Select the repositories you want to use.
  6. Return to Runners.
  7. Open and review each Peak pull request.
Review any request for updated App permissions on GitHub. Allow workflow edits and pull request creation to use browser setup. Check the jobs marked for manual review before you merge. Fill in any missing commands in a new starter workflow. Confirm runner availability before you move jobs.

​
Add more repositories

Choose Add repositories beside the organization on Runners. Change the repository selection on GitHub. Return to Peak to review the setup pull requests. For another organization, choose Add organization. Connect an existing installation or choose Another organization. If an organization is connected to another workspace, remove it there first. If it has runners in that workspace, resolve those runners before you try to move it.

​
Check setup progress

Complete the three steps in your setup list. Connect GitHub, choose a repository, then merge the pull request. Check for a Peak job on the pull request’s base branch after merge. Use the current pilot without minute credits or usage billing.

​
Fix setup errors

If setup fails, read the error beside your repository. Fix the stated issue, then retry the failed step. If asked to update permissions, choose Update permissions. Accept the new permissions on GitHub, then retry. If the runner group could not be updated, retry beside that error. Keep the existing pull request. If GitHub access expires, reconnect in Settings → GitHub.

​
Remove a repository

Revert merged workflow changes before you stop using Peak runners. Choose Remove beside the repository on Runners. Confirm the removal. Check that any open Peak setup pull request is closed. To remove the App’s access too, choose Add repositories beside the organization. Remove the repository from the GitHub App’s selection. To use the repository again, choose Add back in Peak. Review the new setup pull request.

​
Remove an organization

Revert merged workflow changes for its repositories first. Choose Remove beside the organization on Runners. Confirm the removal. Follow Uninstall on GitHub to remove the App from the organization.