https://github.com/stoat-dev/stoat-action

Turn pull request comments into developer dashboards.
https://github.com/stoat-dev/stoat-action

ci-cd-pipeline comment continuous-integration developer-tools github-action pull-request pull-requests stoat template

Last synced: 3 months ago
JSON representation

Turn pull request comments into developer dashboards.

• Host: GitHub
• URL: https://github.com/stoat-dev/stoat-action
• Owner: stoat-dev
• License: mit
• Created: 2022-11-21T05:09:29.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-01T23:58:34.000Z (4 months ago)
• Last Synced: 2024-10-23T08:49:51.256Z (3 months ago)
• Topics: ci-cd-pipeline, comment, continuous-integration, developer-tools, github-action, pull-request, pull-requests, stoat, template
• Language: TypeScript
• Homepage: https://www.stoat.dev
• Size: 10.3 MB
• Stars: 66
• Watchers: 1
• Forks: 3
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - stoat-dev/stoat-action - Turn pull request comments into developer dashboards. (TypeScript)

README

        



  


  

  


  Stoat

  




Turn pull request comments into developer dashboards.




  

    

  

  

    

  

  

    

  

  

    

  





  

    

  

  

    

  





  Quick Start •

  How to Use Stoat •

  License









## Quick Start

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](https://github.com/apps/stoat-app/) and install the application for your repository.

### 2. Install CLI

Requirements:

- Node/NPM

- Mac/Linux

To install the 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:



Stoat is capable of quite a bit more. [Check out our docs for more information »](https://docs.stoat.dev/)

## How to Use Stoat

* [For Java Engineers](https://docs.stoat.dev/docs/why-stoat/java)

* [For JavaScript Engineers](https://docs.stoat.dev/docs/why-stoat/javascript)

* [For Python Engineers](https://docs.stoat.dev/docs/why-stoat/python)

* [For DevOps Engineers](https://docs.stoat.dev/docs/why-stoat/devops)

* [For Engineering Managers](https://docs.stoat.dev/docs/why-stoat/managers)

## License

MIT