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

@@ -17,16 +17,48 @@ Check out [GitHub topics](https://github.com/topics) to search interesting topic
This uses puppeteer to navigate through your starred topics page.
#### ➡️ Available options
<!--options-->
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_topics` | `boolean` **[no]** | Display starred topics |
| `plugin_topics_mode` | `string` **[starred]** *{"starred", "icons", "mastered"}* | Plugin mode |
| `plugin_topics_sort` | `string` **[stars]** *{"stars", "activity", "starred", "random"}* | Sorting method of starred topics |
| `plugin_topics_limit` | `number` **[15]** *{0 ≤ 𝑥 ≤ 20}* | Maximum number of topics 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_topics: yes
plugin_topics_sort: stars # Sort by most starred topics
plugin_topics_mode: icons # Display icons instead of labels
plugin_topics_limit: 0 # Disable limitations
name: Labels
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.topics.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ''
plugin_topics: 'yes'
plugin_topics_limit: 12
```
```yaml
name: Icons
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.topics.icons.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ''
plugin_topics: 'yes'
plugin_topics_limit: 0
plugin_topics_mode: icons
```
<!--/examples-->