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,17 +9,39 @@ The *starlists* plugin displays your recently star lists.
</td>
</table>
#### ➡️ Available options
<!--options-->
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_starlists` ✨ | `boolean` **[no]** | Display star lists |
| `plugin_starlists_limit` ✨ | `number` **[2]** *{1 ≤ 𝑥 ≤ 100}* | Number of star lists to display |
| `plugin_starlists_limit_repositories` ✨ | `number` **[2]** *{0 ≤ 𝑥 ≤ 100}* | Number of repositories to display per star lists |
| `plugin_starlists_shuffle_repositories` ✨ | `boolean` **[yes]** | Shuffle displayed repositories |
| `plugin_starlists_ignored` ✨ | `array` *(comma-separated)* **[]** | Star lists to skip |
| `plugin_starlists_only` ✨ | `array` *(comma-separated)* **[]** | Star lists 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_starlists: yes
plugin_starlists_limit: 16 # Limit to 16 entries
plugin_starlists_limit_repositories: 2 # Limit to 2 repositories per entries
plugin_starlists_ignored: list1, list2 # Ignored lists
plugin_starlists_only: list3 # Only display this list
```
name: Featured star list
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.starlists.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ''
plugin_starlists: 'yes'
plugin_starlists_limit_repositories: 2
plugin_starlists_only: 🤘 TC39
```
<!--/examples-->