GitHub and Actions minutes

GitHub's plans include a number of Actions minutes a month, shared by every repository. AperioFlow shows how many are used and lets you share them out between projects.

The Minutes page

Minutes in the main menu shows the month's GitHub Actions minutes:

• Used this month against the allowance, Left this month, how much is Shared out between projects (with the reserve kept back), and anything Charged beyond the plan.
• A bar for the whole account, amber from 80% and red when over.
• Each project's allowance: each project with a repository link, its allowance, minutes used and minutes left.
• Not linked to a project: repositories no project claims, with the minutes they used.

Minutes count times their runner: Linux x1, Windows x2, macOS x10. Months are calendar months in UTC.

Where the figures come from

AperioFlow reads GitHub's usage report every hour through the organisation's GitHub connection (below), and Refresh from GitHub reads it again (at most once a minute). For a GitHub organisation, GitHub's owners must approve the AperioFlow app's permission to read usage; for a personal account, an owner chooses Reconnect GitHub. Figures more than 6 hours old are marked.

Set the allowances

1. In Settings, set Included minutes a month (your GitHub plan's minutes) and the Reserve to keep back.
2. Give each project a Repository URL in its editor. A repository counts towards the project whose link points at it.
3. On Minutes, type each project's Allowance and choose Save.

All the allowances together can be at most the included minutes less the reserve. Leave a box empty for no allowance. Admins and owners set allowances.

A build script can ask whether a run fits before it starts: GET /api/projects/{id}/actions-minutes?planned=N answers with fits true only when the project has an allowance and the planned minutes fit both it and the account. See API: organisation, members and billing.

Connect GitHub

Owners connect GitHub under Settings, GitHub connection, with Connect GitHub. GitHub asks which repositories AperioFlow may see.

Once connected:

• A pull request whose title, branch name or description mentions a task key such as AF-12 is linked to that task, and the task shows the pull request's number and state. Only the key, repository, pull request number and state are kept; the text is thrown away and your code is never read.
• Tick A merged pull request marks its tasks done to close tasks when their pull request merges.

Disconnect removes the repositories and deletes the links to pull requests at once.