Get billing for Github Actions
ActionsTags
(1)This JavaScript GitHub Action gets the billing for the current month's GitHub Actions.
In this example, the Slack notification section is implemented using the Slack Notify - GitHub Action.
-
Create a workflow file
Please add to an existing workflow file with reference to the following.name: Notify the billing of GitHub Actions for the current month to Slack on: schedule: # ref: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule - cron: '0 9 * * 1' jobs: check-github-actions-usage: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v3 - uses: actions/setup-node@v3 with: node-version: 18 - name: Get billing for GitHub Actions id: get-billing-for-github-actions uses: keita-hino/[email protected] with: # For organization accounts, set the `org` parameter. account-type: user github-token: ${{ secrets.PAT_ACCESS_TOKEN }} - name: Slack Notification uses: rtCamp/action-slack-notify@v2 env: SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }} SLACK_TITLE: Usage of GitHub Actions for the current month MSG_MINIMAL: true SLACK_MESSAGE: > The usage limit of GitHub Actions for the current plan is *${{steps.get-billing-for-github-actions.outputs.included-minutes}}* minutes. The usage for this month is *${{steps.get-billing-for-github-actions.outputs.total-minutes-used}}* minutes, and there are *${{steps.get-billing-for-github-actions.outputs.usable-minutes}}* minutes remaining. The next reset day is in *${{steps.get-billing-for-github-actions.outputs.days-left-in-billing-cycle}}* days.
-
Create a PAT
To use this workflow, you will need to create a Personal Access Token (PAT) with the necessary permissions. -
Set the created PAT as a secret
Please set the created PAT as a secret namedACCESS_TOKEN
.
https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository -
Set the created SLACK_WEBHOOK as a secret Please refer to the following instructions to set up SLACK_WEBHOOK as a secret.
https://github.com/rtCamp/action-slack-notify#usage
Name | Description |
---|---|
account-type | user or org . The default is user . |
github-token | Personal Access Token (PAT) |
Name | Description |
---|---|
included-minutes | The amount of free GitHub Actions minutes available |
total-minutes-used | The sum of the free and paid GitHub Actions minutes used |
usable-minutes | The value obtained by subtracting total-minutes-used from included-minutes |
days-left-in-billing-cycle | Numbers of days left in billing cycle |
All scripts in this project are released under the MIT License.
Get billing for Github Actions is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.