docs: updated workflows examples and options descriptions (#772) [skip ci]
This commit is contained in:
@@ -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-->
|
||||
8
source/plugins/discussions/examples.yml
Normal file
8
source/plugins/discussions/examples.yml
Normal 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
|
||||
Reference in New Issue
Block a user