Documentation

From a plan to a green check run on your own pull request.

• Getting startedSix steps from a plan to a check run. Apex Actions installs as a GitHub App, and your workflow files stay exactly as they are.
• Your first runWhat the pull request looks like after the first push runs on Apex, and where to find the log, the verdict and the timing.

Moving a repository over, and the settings that do not travel with it.

• Migrating from GitHub-hosted runnersA migration is an installation. What to check before, what changes in the pull request, and how to roll back.
• Secrets and variablesWhere a workflow's secrets and variables come from on Apex, how to add them from the dashboard or the terminal, and what the job's own token can and cannot reach.
• Tokens for scripts and CICreate, edit, list and revoke the tokens the apex CLI and API use — the permissions a token carries, its Account, how long it lasts, and how to use one in CI.
• Access and rolesWho may do what on a repository in Apex Actions — your Account's roles, not GitHub's permissions — and what "not connected to an Apex Account" means.

Look it up: every command, every workflow feature, every runner size.

• CLI referenceEvery apex command, its options and an example of each — grouped by what you are trying to do.
• Compatibility matrixEvery feature of GitHub Actions workflow syntax, what Apex Actions does with it, and the conformance fixture that proves it.
• Runner sizesThe standard runner and the larger sizes, which are included in every plan and selected with one label.