Skip to content

Commit

Permalink
Add notes to README
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
  • Loading branch information
alexellis committed Mar 2, 2023
1 parent b2fdc9d commit 847823c
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## actions-usage

Find your GitHub Actions usage across a given organisation.
Find your GitHub Actions usage across a given organisation (or user account).

Includes total runtime of all workflow runs and workflow jobs, including where the jobs were run within inclusive, free, billed minutes, or on self-hosted runners.

Expand All @@ -19,14 +19,16 @@ If your team has hundreds of repositories, or thousands of builds per month, the

## Usage

This tool is primarily designed for use with an organisation, however you can also use it with a regular user account by changing the `--org` flag to `--user`.

Or create a [Classic Token](https://github.com/settings/tokens) with: repo and admin:org and save it to ~/pat.txt. Create a short lived duration for good measure.

Download a binary from the [releases page](https://github.com/self-actuated/actions-usage/releases)

## Output

```bash
./actions-usage --org openfaas --token $(cat ~/pat.txt)
actions-usage --org openfaas --token $(cat ~/pat.txt)

Fetching last 30 days of data (created>=2023-01-29)

Expand All @@ -39,6 +41,12 @@ Total workflow jobs: 113
Total usage: 6h16m16s (376 mins)
```

As a user:

```bash
actions-usage --user alexellis --token $(cat ~/pat.txt)
```

## Development

All changes must be proposed with an Issue prior to working on them or sending a PR. Commits must have a sign-off message, i.e. `git commit -s`
Expand Down

0 comments on commit 847823c

Please sign in to comment.