docs: updated workflows examples and options descriptions (#772) [skip ci]

This commit is contained in:
Simon Lecoq
2022-01-14 04:49:14 +01:00
committed by GitHub
parent 44e3992ca9
commit 4d06539136
80 changed files with 2292 additions and 450 deletions

View File

@@ -14,13 +14,33 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
![Token with repo scope](/.github/readme/imgs/setup_token_repo_scope.png)
#### ➡️ Available options
<!--options-->
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_traffic` | `boolean` **[no]** | Display repositories traffic metrics |
| `plugin_traffic_skipped` | `array` *(comma-separated)* **[]** | Repositories to skip |
Legend for option icons:
* 🔐 Value should be stored in repository secrets
* ✨ New feature currently in testing on `master`/`main`
<!--/options-->
*[→ Full specification](metadata.yml)*
#### Examples workflows
[➡️ Available options for this plugin](metadata.yml)
<!--examples-->
```yaml
- uses: lowlighter/metrics@latest
with:
# ... other options
plugin_traffic: yes
name: Repositories traffic
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.traffic.svg
token: ${{ secrets.METRICS_TOKEN }}
base: repositories
plugin_traffic: 'yes'
```
<!--/examples-->

View File

@@ -0,0 +1,9 @@
- name: Repositories traffic
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.traffic.svg
token: ${{ secrets.METRICS_TOKEN }}
base: repositories
plugin_traffic: yes
prod:
token: ${{ secrets.METRICS_BOT_TOKEN }}