ci: auto-regenerate files

action.yml

@@ -49,234 +49,198 @@ inputs:
   # ====================================================================================
   # 🧱 Core
   
-  # User account personal token
+  
-  # No additional scopes are needed unless you want to include private repositories metrics
-  # Some plugins may also require additional scopes
-  # ────────────────────────────────────────────────────────────────
-  # If you're only using plugins which don't really require a GitHub token, you may pass "NOT_NEEDED" as value
   token:
-    description: GitHub Personal Token
+    description: GitHub Personal Access Token
     required: true
   
-  # GitHub username
+  
-  # Defaults to "token" owner
   user:
     description: GitHub username
     default: ""
   
-  # GitHub repository
+  
-  # Compute metrics for a repository instead ("user" being the repository owner)
-  # Check https://github.com/lowlighter/metrics/blob/master/source/templates/repository/README.md for more informations
   repo:
     description: GitHub repository
     default: ""
   
-  # Set to "${{ github.token }}" or "${{ secrets.GITHUB_TOKEN }}"
+  
-  # GITHUB_TOKEN is a special auto-generated token restricted to current repository, which is used to push files in it
   committer_token:
     description: GitHub Token used to commit metrics
     default: ${{ github.token }}
   
-  # Branch used to commit rendered metrics
+  
   committer_branch:
-    description: Branch used to commit rendered metrics
+    description: Target branch
     default: ""
   
-  # Commit message
+  
-  # Use "${filename}" to display filename
   committer_message:
     description: Commit message
     default: Update ${filename} - [Skip GitHub Action]
   
-  # Instead of saving metrics to a repository, it's possible to save them to a gist to avoid "commits pollution"
+  
-  # Gist must be created prior and you must pass its identifier in the following option
-  # Set "gist" in "output_action" to use this option
   committer_gist:
-    description: Gist used to store metrics
+    description: Gist id
     default: ""
   
-  # Rendered metrics output path, relative to repository's root
+  
-  # When using "*", the correct extension will automatically on "config_output" value
   filename:
-    description: Rendered metrics output path
+    description: Output path
     default: github-metrics.*
   
-  # Rendered markdown output path (when using a markdown template)
+  
-  # It can be either a local path or a link (e.g. raw.githubusercontent.com)
   markdown:
-    description: Rendered markdown output path
+    description: Markdown template path
     default: TEMPLATE.md
   
-  # Rendered markdown file cache (when using a markdown template)
+  
   markdown_cache:
-    description: Rendered markdown file cache
+    description: Markdown file cache
     default: .cache
   
-  # Output action
+  
   output_action:
     description: Output action
     default: commit
   
-  # Output condition
+  
   output_condition:
     description: Output condition
-    default: always
   
-  # Optimize SVG image to reduce its filesize
+  
-  # Some templates may not support this option
   optimize:
-    description: SVG optimization
+    description: Optimization features
     default: css, xml
   
   # Setup additional templates from remote repositories
   setup_community_templates:
-    description: Additional community templates to setup
+    description: Community templates to setup
     default: ""
   
-  # Template to use
+  
-  # To use community template, prefix its name with "@"
   template:
-    description: Template to use
+    description: Template
     default: classic
   
-  # Additional query parameters (JSON string)
+  
-  # Some templates may require additional parameters which you can specify here
-  # Do not use this option to pass plugins parameters as they'll be overwritten by the other options
   query:
-    description: Additional query parameters
+    description: Query parameters
     default: "{}"
   
-  # Define additional CSS that will be injected in used template
+  
-  # Example:
-  # config_extras_css꞉ |
-  #   h2 {
-  #     color: red;
-  #   }
   extras_css:
     description: Extra CSS
     default: ""
   
-  # Timezone used by metrics
+  
-  # See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
   config_timezone:
-    description: Timezone used
+    description: Timezone for dates
     default: ""
   
-  # Specify in which order metrics content will be displayed
+  
-  # If you omit some partials, they'll be appended at the end in default order
-  # See "partials/_.json" of each template for a list of supported partials
   config_order:
-    description: Configure content order
+    description: Plugin order
     default: ""
   
-  # Use twemojis instead of emojis
+  
-  # May increase filesize but emojis will be rendered the same across all platforms
   config_twemoji:
-    description: Use twemojis instead of emojis
+    description: Use twemojis
     default: no
   
-  # Render GitHub custom emojis (like ":octocat:", see full list at https://api.github.com/emojis)
+  
-  # May increase filesize
   config_gemoji:
     description: Use GitHub custom emojis
     default: yes
   
-  # Render display width
+  
   config_display:
-    description: Render display width
+    description: Display width (for image output formats)
     default: regular
   
-  # Enable SVG CSS animations
+  
   config_animations:
-    description: SVG CSS animations
+    description: Use CSS animations
     default: yes
   
-  # Encode images links into base64 data
+  
-  # Advised to be true when generating images and false when generating texts or JSON
   config_base64:
-    description: Encode images links into base64 data
+    description: Base64-encoded images
     default: yes
   
-  # Configure padding for output image (percentage value)
+  
-  # It can be used to add padding to generated metrics if rendering is cropped or has too much empty space
-  # Specify one value (for both width and height) or two values (one for width and one for height)
   config_padding:
-    description: Image padding
+    description: Output padding
     default: 0, 8 + 11%
   
-  # Metrics output format
+  
   config_output:
-    description: Output image format
+    description: Output format
     default: auto
   
-  # Number of retries in case rendering fail
+  
   retries:
-    description: Number of retries
+    description: Retries in case of failures (for rendering)
     default: 3
   
-  # Time to wait (in seconds) before each retry
+  
   retries_delay:
-    description: Time to wait (in seconds) before each retry
+    description: Delay between each retry (in seconds, for rendering)
     default: 300
   
-  # Number of retries in case output action fail
+  
   retries_output_action:
-    description: Number of retries (output action)
+    description: Retries in case of failures (for output action)
     default: 5
   
-  # Time to wait (in seconds) before each retry (output action)
+  
   retries_delay_output_action:
-    description: Time to wait (in seconds) before each retry (output action)
+    description: Delay between each retry (in seconds, for output action)
     default: 120
   
-  # Time to wait (in seconds) at the end of job
+  
-  # Use this to avoid triggering abuse mechanics on large workflows
   delay:
-    description: Use this to avoid triggering abuse mechanics on large workflows
+    description: Job delay
     default: 0
   
-  # Use a pre-built image from GitHub registry when using unreleased versions of "lowlighter/metrics"
+  
-  # This option has no effect on forks (images will always be rebuilt from Dockerfile)
-  # See https://github.com/users/lowlighter/packages/container/package/metrics for more information
   use_prebuilt_image:
-    description: Use pre-built image from GitHub registry
+    description: >-
+      Use pre-built docker image from [GitHub container
+      registry](https://github.com/lowlighter/metrics/pkgs/container/metrics)
     default: yes
   
-  # Throw on plugins errors
+  
-  # If disabled, metrics will handle errors gracefully with a message in rendered metrics
   plugins_errors_fatal:
-    description: Die on plugins errors
+    description: Fatal plugin errors
     default: no
   
-  # Debug mode
+  
-  # Note that this will automatically be enabled if job fails
   debug:
-    description: Debug logs
+    description: Debug mode
     default: no
   
-  # Ensure SVG can be correctly parsed after generation
+  
   verify:
-    description: Verify SVG
+    description: SVG validity check
     default: no
   
-  # Debug flags
+  
   debug_flags:
     description: Debug flags
     default: ""
   
-  # Dry-run mode (perform generation without output)
+  
-  # Unlike "output_action" set to "none", output file won't be available in "/metrics_renders"
   dryrun:
-    description: Enable dry-run
+    description: Dry-run
     default: no
   
-  # Experimental features
+  
-  # Note that no backward compatibility are guaranteed for these features
   experimental_features:
     description: Experimental features
     default: ""
   
-  # Use mocked data to bypass external APIs
+  
   use_mocked_data:
     description: Use mocked data instead of live APIs
     default: no

source/plugins/posts/README.md

@@ -15,8 +15,8 @@
   </tr>
   <tr>
     <td colspan="2" align="center">
-      <details open><summary>Latest posts</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.posts.svg" alt=""></img></details>
+      <details><summary>Latest posts</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.posts.svg" alt=""></img></details>
-      <details><summary>Latest posts width description and cover image</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.posts.full.svg" alt=""></img></details>
+      <details open><summary>Latest posts width description and cover image</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.posts.full.svg" alt=""></img></details>
       <img width="900" height="1" alt="">
     </td>
   </tr>
@@ -123,6 +123,7 @@ with:
   base: ''
   plugin_posts: 'yes'
   plugin_posts_source: dev.to
+  plugin_posts_limit: 2
   plugin_posts_descriptions: 'yes'
   plugin_posts_covers: 'yes'
 

source/plugins/sponsors/README.md

@@ -16,7 +16,7 @@
   <tr>
     <td colspan="2" align="center">
       <details open><summary>GitHub sponsors card</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.svg" alt=""></img></details>
-      <details open><summary>GitHub sponsors full introduction</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.full.svg" alt=""></img></details>
+      <details><summary>GitHub sponsors full introduction</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.full.svg" alt=""></img></details>
       <img width="900" height="1" alt="">
     </td>
   </tr>

source/plugins/tweets/README.md

@@ -15,8 +15,8 @@
   </tr>
   <tr>
     <td colspan="2" align="center">
-      <details open><summary>Latest tweets</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.tweets.svg" alt=""></img></details>
+      <details open><summary>Latest tweets with attachments</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.tweets.attachments.svg" alt=""></img></details>
-      <details><summary>Latest tweets with attachments</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.tweets.attachments.svg" alt=""></img></details>
+      <details><summary>Latest tweets</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.tweets.svg" alt=""></img></details>
       <img width="900" height="1" alt="">
     </td>
   </tr>
@@ -121,6 +121,7 @@ with:
   plugin_tweets_token: ${{ secrets.TWITTER_TOKEN }}
   plugin_tweets_attachments: 'yes'
   plugin_tweets_user: github
+  plugin_tweets_limit: 1
 
 ```
 <!--/examples-->

tests/cases/posts.plugin.yml

@@ -12,6 +12,7 @@
     token: MOCKED_TOKEN
     plugin_posts: 'yes'
     plugin_posts_source: dev.to
+    plugin_posts_limit: 2
     plugin_posts_descriptions: 'yes'
     plugin_posts_covers: 'yes'
     use_mocked_data: 'yes'

tests/cases/tweets.plugin.yml

@@ -15,5 +15,6 @@
     plugin_tweets_token: MOCKED_TOKEN
     plugin_tweets_attachments: 'yes'
     plugin_tweets_user: github
+    plugin_tweets_limit: 1
     use_mocked_data: 'yes'
     verify: 'yes'