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

@@ -9,13 +9,35 @@ The *discussions* plugin displays your GitHub discussions metrics.
</td>
</table>
#### ➡️ Available options
<!--options-->
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_discussions` | `boolean` **[no]** | GitHub discussions metrics |
| `plugin_discussions_categories` ✨ | `boolean` **[yes]** | Display discussion categories |
| `plugin_discussions_categories_limit` ✨ | `number` **[0]** | Number of discussion categories to display |
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_discussions: yes
```
name: GitHub Discussions
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.discussions.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ''
plugin_discussions: 'yes'
plugin_discussions_categories_limit: 8
```
<!--/examples-->

View File

@@ -0,0 +1,8 @@
- name: GitHub Discussions
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.discussions.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ""
plugin_discussions: yes
plugin_discussions_categories_limit: 8