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

@@ -15,14 +15,46 @@ It is mostly intended for metrics used outside of GitHub, since these informatio
</td>
</table>
#### ➡️ Available options
<!--options-->
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_introduction` | `boolean` **[no]** | Display account or repository introduction |
| `plugin_introduction_title` | `boolean` **[yes]** | Display introduction section title |
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_introduction: yes
plugin_introduction_title: no # Hide section title
```
name: User introduction
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.introduction.svg
token: ${{ secrets.METRICS_TOKEN }}
user: github
base: header
plugin_introduction: 'yes'
```
```yaml
name: Repository introduction
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.introduction.repository.svg
token: ${{ secrets.METRICS_TOKEN }}
template: repository
repo: metrics
base: header
plugin_introduction: 'yes'
```
<!--/examples-->

View File

@@ -0,0 +1,20 @@
- name: User introduction
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.introduction.svg
token: ${{ secrets.METRICS_TOKEN }}
user: github
base: header
plugin_introduction: yes
prod:
token: ${{ secrets.METRICS_BOT_TOKEN }}
- name: Repository introduction
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.introduction.repository.svg
token: ${{ secrets.METRICS_TOKEN }}
template: repository
repo: metrics
base: header
plugin_introduction: yes