Add gist upload output action (#212)

This commit is contained in:
Simon Lecoq
2021-04-07 22:17:49 +02:00
committed by GitHub
parent a1e55b3a6f
commit 38fbcea554
3 changed files with 24 additions and 2 deletions

View File

@@ -153,7 +153,7 @@ Specify a single value to apply it to both height and with, and two values to us
config_padding: 6%, 10% # 6% width padding, 10% height padding
```
### 🧶 Using commits, pull requests or manual review to handle metrics output
### 🧶 Using commits, pull requests, manual reviews or gists to handle metrics output
It is possible to configure output behaviour using `output_action` option, which can be set to:
- `none`, where output will be generated in `/rendered/${filename}` without being pushed
@@ -163,6 +163,8 @@ It is possible to configure output behaviour using `output_action` option, which
- By appending either `-merge`, `-squash` or `-rebase`, pull request will be automatically merged with given method
- This method is useful to combine all editions of a single run with multiples metrics steps into a single commit on targetted branch
- If you choose to manually merge pull requests, be sure to disable `push:` triggers on your workflow, as it'll count as your own commit
- `gist`, where output will be stored an already existing gist
- To use this feature, a `gists` scope must be granted to your `token` and `committer_gist` identifier must be provided
#### Examples workflows

View File

@@ -52,6 +52,14 @@ inputs:
type: string
default: Update ${filename} - [Skip GitHub Action]
# Instead of saving metrics to a repository, it's possible to save them to a gist to avoid "commits pollution"
# Gist must be created prior and you must pass its identifier in the following option
# Set "gist" in "output_action" to use this option
committer_gist:
description: Gist used to store metrics
type: string
default: ""
# Rendered metrics output path, relative to repository's root
filename:
description: Rendered metrics output path
@@ -83,6 +91,7 @@ inputs:
- pull-request-merge # Same as "pull-request" and additionaly merge pull request
- pull-request-squash # Same as "pull-request" and additionaly squash and merge pull request
- pull-request-rebase # Same as "pull-request" and additionaly rebase and merge pull request
- gist # Save output to "committer_gist"
# Optimize SVG image to reduce its filesize
# Some templates may not support this option