diff options
| author | Franck Cuny <franck@fcuny.net> | 2024-01-25 17:47:06 -0800 |
|---|---|---|
| committer | Franck Cuny <franck@fcuny.net> | 2024-01-25 17:47:06 -0800 |
| commit | a29ce6603158b4d924278cdbd7a81e63633cf0f3 (patch) | |
| tree | 5a18617a9f882de2ae5e4600d2704b30f0e921eb /cmd/ghabilling/README.md | |
| parent | build binaries and run commands on CI (diff) | |
| download | infra-a29ce6603158b4d924278cdbd7a81e63633cf0f3.tar.gz | |
gha-billing: how many minutes are left in the cycle
Diffstat (limited to 'cmd/ghabilling/README.md')
| -rw-r--r-- | cmd/ghabilling/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/cmd/ghabilling/README.md b/cmd/ghabilling/README.md new file mode 100644 index 0000000..2aa08ce --- /dev/null +++ b/cmd/ghabilling/README.md @@ -0,0 +1,15 @@ +# `gha-billing` + +Print information about how many free minutes of GitHub actions are left for this cycle. + +The API for this is documented [here](https://docs.github.com/en/rest/billing/billing?apiVersion=2022-11-28#get-github-actions-billing-for-an-organization). + +For this you need a [token](https://github.com/settings/personal-access-tokens) with the following permissions: +- [plan](https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens?apiVersion=2022-11-28#user-permissions-for-plan) + +## usage + +```sh +➜ world git:(main) ✗ go run ./cmd/ghabilling -t github_pat_<TOKEN> +this cycle, 14 minutes have been used, and 1986 minutes are remaining +``` |