docs: update quickstart utilities [skip ci]
This commit is contained in:
23
.github/scripts/quickstart/plugin/README.md
vendored
23
.github/scripts/quickstart/plugin/README.md
vendored
@@ -1,19 +1,12 @@
|
||||
### 🧩 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %>
|
||||
<!--header-->
|
||||
<!--/header-->
|
||||
|
||||
<table>
|
||||
<td align="center">
|
||||
<img src="">
|
||||
<img width="900" height="1" alt="">
|
||||
</td>
|
||||
</table>
|
||||
## ➡️ Available options
|
||||
|
||||
#### ℹ️ Examples workflows
|
||||
<!--options-->
|
||||
<!--/options-->
|
||||
|
||||
[➡️ Available options for this plugin](metadata.yml)
|
||||
## ℹ️ Examples workflows
|
||||
|
||||
```yaml
|
||||
- uses: lowlighter/metrics@latest
|
||||
with:
|
||||
# ... other options
|
||||
plugin_<%= name %>: yes
|
||||
```
|
||||
<!--examples-->
|
||||
<!--/examples-->
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
- name: <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %> plugin (default)
|
||||
- name: Example
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
filename: metrics.plugin.<%= name %>.svg
|
||||
token: ${{ secrets.METRICS_TOKEN }}
|
||||
base: ""
|
||||
plugin_<%= name %>: yes
|
||||
prod:
|
||||
skip: true
|
||||
|
||||
18
.github/scripts/quickstart/plugin/metadata.yml
vendored
18
.github/scripts/quickstart/plugin/metadata.yml
vendored
@@ -1,14 +1,16 @@
|
||||
name: "🧩 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %>"
|
||||
category: community # Leave as it
|
||||
category: community
|
||||
description: Short description
|
||||
examples:
|
||||
default: https://via.placeholder.com/468x60?text=No%20preview%20available
|
||||
supports:
|
||||
- user # Support users account
|
||||
- organization # Support organizations account
|
||||
- repository # Support repositories metrics
|
||||
scopes: [] # Required scopes for personal access token
|
||||
- user
|
||||
- organization
|
||||
- repository
|
||||
scopes: []
|
||||
inputs:
|
||||
|
||||
# Enable or disable plugin
|
||||
plugin_<%= name %>:
|
||||
description: description
|
||||
description: Enable <%= name %> plugin
|
||||
type: boolean
|
||||
default: no
|
||||
default: no
|
||||
|
||||
Reference in New Issue
Block a user