diff --git a/.github/scripts/quickstart/plugin/README.md b/.github/scripts/quickstart/plugin/README.md index 18a0ff9e..3eff2a87 100644 --- a/.github/scripts/quickstart/plugin/README.md +++ b/.github/scripts/quickstart/plugin/README.md @@ -1,19 +1,12 @@ -### 🧩 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %> + + - - -
- - -
+## ➡️ Available options -#### ℹ️ Examples workflows + + -[➡️ Available options for this plugin](metadata.yml) +## ℹ️ Examples workflows -```yaml -- uses: lowlighter/metrics@latest - with: - # ... other options - plugin_<%= name %>: yes -``` \ No newline at end of file + + diff --git a/.github/scripts/quickstart/plugin/examples.yml b/.github/scripts/quickstart/plugin/examples.yml index ababa457..2cea4290 100644 --- a/.github/scripts/quickstart/plugin/examples.yml +++ b/.github/scripts/quickstart/plugin/examples.yml @@ -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 diff --git a/.github/scripts/quickstart/plugin/metadata.yml b/.github/scripts/quickstart/plugin/metadata.yml index 52b73d0f..3d0785a8 100644 --- a/.github/scripts/quickstart/plugin/metadata.yml +++ b/.github/scripts/quickstart/plugin/metadata.yml @@ -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 \ No newline at end of file + default: no diff --git a/.github/scripts/quickstart/template/image.svg b/.github/scripts/quickstart/template/image.svg index e4a2dc70..8865376c 100644 --- a/.github/scripts/quickstart/template/image.svg +++ b/.github/scripts/quickstart/template/image.svg @@ -2,6 +2,7 @@ +
diff --git a/.github/scripts/quickstart/template/metadata.yml b/.github/scripts/quickstart/template/metadata.yml index 1f59c6a6..e4cea326 100644 --- a/.github/scripts/quickstart/template/metadata.yml +++ b/.github/scripts/quickstart/template/metadata.yml @@ -1,14 +1,16 @@ name: "🖼️ Template name" -extends: classic # Fallback to "classic" template "template.mjs" if not trusted -index: ~ # Leave as it (this is used to order plugins on metrics README.md) +extends: classic +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 + - user + - organization + - repository formats: - - svg # Support SVG output - - png # Support PNG output - - jpeg # Support JPEG output - - json # Support JSON output - - markdown # Support markdown output - - markdown-pdf # Support PDF output \ No newline at end of file + - svg + - png + - jpeg + - json + - markdown + - markdown-pdf