Ghamma

Fetch workflow run durations for Github Actions.

Install the gem and add to the application's Gemfile by executing:

$ bundle add ghamma

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install ghamma

The Github workflows API requires an authenticated user, even for public repos. To use this tool, you will need a Github API Token with at least read access to the repo you want to look at.

Once you have that, make it available.

$ export GH_TOKEN="YOUR_API_TOKEN"

Then fetch the list of available workflows for the repo. The name will be necessary in the next step.

$ ghamma list-workflows tony-rowan ghamma
Found 1 workflows
Ruby

Then fetch a CSV of the durations of the latest workflow runs.

$ ghamma duration-history tony-rowan ghamma Ruby
Date,Duration
2023-06-01T15:44:49Z,21000
2023-06-01T15:37:21Z,17000
2023-06-01T15:35:16Z,23000
2023-06-01T15:31:33Z,19000

After checking out the repo, run bin/setup to install dependencies. Then, run rake test-unit to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Bug reports and pull requests are welcome on GitHub at https://github.com/tony-rowan/ghamma. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Ghamma project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.