Getting started
Install the App
Apex Actions is a GitHub App. Installing it on an organisation is the only change GitHub sees; your workflow files stay exactly as they are.
Three steps
Install the App
Choose the organisation and the repositories. The App asks for checks, contents and metadata — the scopes a CI provider needs and no more.
Choose a plan
Every plan starts with a 10-day trial, without a card. Pick the one that fits the size of the team.
Push
The next push produces a check run on the commit, with annotations and a log, from an Apex runner.
What the App asks for
| Permission | Why |
|---|---|
| Checks: read and write | To create the check run on the commit and post annotations |
| Contents: read | To read the workflow files and check out the repository |
| Metadata: read | To know which repositories the App is installed on |
| Pull requests: read | To post the flaky-test warning as a comment on the pull request |
Turning off hosted runners
While both are installed, GitHub-hosted runners and Apex will each run the workflow. Disable Actions on the organisation, or on the repositories you move, once you have seen the first Apex run — the App keeps receiving the events either way.