docs: updated workflows examples and options descriptions (#772) [skip ci]
This commit is contained in:
@@ -14,13 +14,33 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
|
||||
|
||||

|
||||
|
||||
#### ➡️ 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-->
|
||||
9
source/plugins/traffic/examples.yml
Normal file
9
source/plugins/traffic/examples.yml
Normal 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 }}
|
||||
Reference in New Issue
Block a user