Tutorial
You can view a chart of GitHub job runtimes in a PR comments in just two minutes!
1. Install GitHub Application
Go to the Stoat GitHub application page and install the application for your repository.
2. Install CLI
Requirements:
- Node/NPM
- Mac/Linux
To install the Stoat CLI, run:
npm i -g stoat
3. Initialize Stoat
To initialize a Stoat project within a Git repository, run:
stoat init
The initialization command will create a configuration file for Stoat at .stoat/config.yaml and will give you the option to add the Stoat GitHub action as the final step in all GitHub jobs. Say yes for every job you want to track job runtimes for. Merge these changes into your repo.
That's it!
You will now see build runtimes tracked in your PRs! Here's what the build history looks like after multiple default branch builds and commits in a PR:
This type of graph will be posted in a PR comment and updated as new commits are pushed to the PR.
There's more!
Stoat aims to turn pull request comments into developer dashboards. It already supports previews for build artifacts (including test coverage reports, documentation static sites, StorybookJS, and more).
Top comments (0)