GitHub Action
Actions Usage
Get your GitHub Actions usage in minutes for either a repository or a specific workflow.
Create a workflow (eg: .github/workflows/seat-count.yml). See Creating a Workflow file.
Anyone with read access to the repository can use this endpoint.
The GITHUB_TOKEN will work for repo level usage.
Personal access tokens (classic) need the repo scope to use this endpoint with a private repository. Organization's will need the repo or admin:org scope to use this endpoint.
This endpoint works with the following token types:
- GitHub App user access tokens
- GitHub App installation access tokens
- Fine-grained personal access tokens
The token must have the following permission set:
If getting the usage for an organization:
organization_administration:read
If getting the usage for a repository:
actions:read
This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.
name: Actions Usage
on:
schedule:
- cron: '0 0 * * *'
jobs:
run:
runs-on: ubuntu-latest
steps:
- uses: austenstone/[email protected]
id: usage
with:
org: ${{ github.repository_owner }}
- run: echo "Total usage: ${{ steps.usage.outputs.total }}"
- if: ${{ steps.usage.outputs.total > 50000 }}
run: echo "Actions Usage is over 50,000 minutes!"Use this action in combination with other actions to notify users.
name: Actions Usage
on:
schedule:
- cron: '0 0 * * *'
jobs:
run:
runs-on: ubuntu-latest
steps:
- uses: austenstone/[email protected]
id: usage
- name: Post to a Slack channel
if: ${{ steps.usage.outputs.total > 50000 }}
id: slack
uses: slackapi/[email protected]
with:
# Slack channel id, channel name, or user id to post message.
# See also: https://api.slack.com/methods/chat.postMessage#channels
# You can pass in multiple channels to post to by providing a comma-delimited list of channel IDs.
channel-id: 'CHANNEL_ID,ANOTHER_CHANNEL_ID'
# For posting a simple plain text message
slack-message: "Your GitHub Actions usage is over 50,000 minutes!"
env:
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}Use this action to switch to a self-hosted runner when you've reached a usage limit.
name: Actions Usage
on:
schedule:
- cron: '0 0 * * *'
jobs:
get-usage:
runs-on: ubuntu-latest
outputs:
total: ${{ steps.usage.outputs.total }}
steps:
- uses: austenstone/[email protected]
id: usage
with:
github-token: ${{ secrets.TOKEN }}
org: ${{ vars.ORG }}
run:
runs-on: ${{ steps.get-usage.outputs.total > 50000 ? 'my-self-hosted-runner' : 'ubuntu-latest' }}
needs: get-usage
steps:
- run: echo "Running"Various inputs are defined in action.yml:
| Name | Description | Default |
|---|---|---|
| github‑token | Token to use to authorize. | ${{ github.token }} |
| workflow | The workflow file name or id. | main.yml |
| org | The organization name. | ${{ github.repository_owner }} |
| repo | The repository name. | ${{ github.repository }} |
| Name | Description |
|---|---|
| ubuntu | The usage in minutes for Ubuntu |
| macos | The usage in minutes for macOS |
| windows | The usage in minutes for Windows |
| total | The total usage in minutes |
| included_minutes | The included minutes |
| total_paid_minutes_used | The total paid minutes used |
To get more help on the Actions see documentation.