https://github.com/c-bata/github-actions-kurobako

GitHub Action to generate kurobako report and comment it to the pull request.
https://github.com/c-bata/github-actions-kurobako

Last synced: 17 days ago
JSON representation

GitHub Action to generate kurobako report and comment it to the pull request.

• Host: GitHub
• URL: https://github.com/c-bata/github-actions-kurobako
• Owner: c-bata
• License: mit
• Created: 2020-01-17T14:35:53.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-08T03:26:47.000Z (10 months ago)
• Last Synced: 2024-10-08T21:06:21.752Z (about 1 month ago)
• Language: Python
• Homepage: https://github.com/marketplace/actions/kurobako-report
• Size: 19.5 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# github-actions-kurobako

GitHub Action to generate [kurobako](https://github.com/sile/kurobako) report and comment it to the pull request.

See [github-actions-kurobako/plot](./plot) action to generate a plot image.



## Inputs

### `report-md-path`

**Required** File path to a json generated by kurobako report command.

### `public-image-url`

**Required**  A public image url to kurobako plot image.

### `title`

**Optional** A text for the title.

## Outputs

There is no output values.

This action just comments to the pull request or edit if previous comment exists.

## Example usage

```yaml

uses: c-bata/github-actions-kurobako@master

with:

  report-md-path: './kurobako-report.md'

  public-image-url: 'https://example.com/public-image-url.png'

  title: 'Benchmark of quadratic function'

```

## License

This software is licensed under the MIT license, see [LICENSE](./LICENSE) for more information.