@@ -7,10 +7,10 @@ Metrics also have general options that impact global metrics rendering.
77<!-- options-->
88| Option | Type * (format)* ** [ default] ** * {allowed values}* | Description |
99| ------ | -------------------------------- | ----------- |
10- | ` token ` 🔐 | ` token ` | GitHub Personal Token |
10+ | ` token ` < sup >✔️</ sup > < sup >🔐</ sup > | ` token ` | GitHub Personal Token |
1111| ` user ` | ` string ` ** [ ] ** | GitHub username |
1212| ` repo ` | ` string ` ** [ ] ** | GitHub repository |
13- | ` committer_token ` 🔐 | ` token ` ** [ ${{ github.token }}] ** | GitHub Token used to commit metrics |
13+ | ` committer_token ` < sup >🔐</ sup > | ` token ` ** [ ${{ github.token }}] ** | GitHub Token used to commit metrics |
1414| ` committer_branch ` | ` string ` ** [ ] ** | Branch used to commit rendered metrics |
1515| ` committer_message ` | ` string ` ** [ Update ${filename} - [ Skip GitHub Action]] ** | Commit message |
1616| ` committer_gist ` | ` string ` ** [ ] ** | Gist used to store metrics |
@@ -20,37 +20,40 @@ Metrics also have general options that impact global metrics rendering.
2020| ` output_action ` | ` string ` ** [ commit] ** * {"none", "commit", "pull-request", "pull-request-merge", "pull-request-squash", "pull-request-rebase", "gist"}* | Output action |
2121| ` output_condition ` | ` string ` ** [ always] ** * {"always", "data-changed"}* | Output condition |
2222| ` optimize ` | ` array ` * (comma-separated)* ** [ css, xml] ** * {"css", "xml", "svg"}* | SVG optimization |
23- | ` setup_community_templates ` | ` array ` * (comma-separated,/(?< user > [ -a-z0-9 ] +) [ / ] ( ?<repo>[-a-z0-9]+ ) @(?< branch > [ -a-z0-9 ] +):(?< template > [ -a-z0-9 ] +)/ )* ** [ ] ** | Additional community templates to setup |
23+ | ` setup_community_templates ` < sup >🧰</ sup > | ` array ` * (comma-separated)* ** [ ] ** | Additional community templates to setup |
2424| ` template ` | ` string ` ** [ classic] ** | Template to use |
2525| ` query ` | ` json ` ** [ {}] ** | Additional query parameters |
26- | ` extras_css ` | ` string ` ** [ ] ** | Extra CSS |
27- | ` config_timezone ` | ` string ` ** [ ] ** | Timezone used |
28- | ` config_order ` | ` array ` * (comma-separated)* ** [ ] ** | Configure content order |
29- | ` config_twemoji ` | ` boolean ` ** [ no] ** | Use twemojis instead of emojis |
30- | ` config_gemoji ` | ` boolean ` ** [ yes] ** | Use GitHub custom emojis |
31- | ` config_display ` | ` string ` ** [ regular] ** * {"regular", "large", "columns"}* | Render display width |
32- | ` config_animations ` | ` boolean ` ** [ yes] ** | SVG CSS animations |
33- | ` config_base64 ` | ` boolean ` ** [ yes] ** | Encode images links into base64 data |
26+ | ` extras_css ` < sup >🧰</ sup > | ` string ` ** [ ] ** | Extra CSS |
27+ | ` config_timezone ` < sup >⏭️</ sup > | ` string ` ** [ ] ** | Timezone used |
28+ | ` config_order ` < sup >⏭️</ sup > | ` array ` * (comma-separated)* ** [ ] ** | Configure content order |
29+ | ` config_twemoji ` < sup >⏭️</ sup > | ` boolean ` ** [ no] ** | Use twemojis instead of emojis |
30+ | ` config_gemoji ` < sup >⏭️</ sup > | ` boolean ` ** [ yes] ** | Use GitHub custom emojis |
31+ | ` config_display ` < sup >⏭️</ sup > | ` string ` ** [ regular] ** * {"regular", "large", "columns"}* | Render display width |
32+ | ` config_animations ` < sup >⏭️</ sup > | ` boolean ` ** [ yes] ** | SVG CSS animations |
33+ | ` config_base64 ` < sup >⏭️</ sup > | ` boolean ` ** [ yes] ** | Encode images links into base64 data |
3434| ` config_padding ` | ` string ` ** [ 0, 8 + 11%] ** | Image padding |
3535| ` config_output ` | ` string ` ** [ auto] ** * {"auto", "svg", "png", "jpeg", "json", "markdown", "markdown-pdf", "insights"}* | Output image format |
3636| ` retries ` | ` number ` ** [ 3] ** * {1 ≤ 𝑥 ≤ 10}* | Number of retries |
3737| ` retries_delay ` | ` number ` ** [ 300] ** * {0 ≤ 𝑥 ≤ 3600}* | Time to wait (in seconds) before each retry |
3838| ` retries_output_action ` | ` number ` ** [ 5] ** * {1 ≤ 𝑥 ≤ 10}* | Number of retries (output action) |
3939| ` retries_delay_output_action ` | ` number ` ** [ 120] ** * {0 ≤ 𝑥 ≤ 3600}* | Time to wait (in seconds) before each retry (output action) |
40- | ` plugins_errors_fatal ` | ` boolean ` ** [ no] ** | Die on plugins errors |
41- | ` debug ` | ` boolean ` ** [ no] ** | Debug logs |
42- | ` verify ` | ` boolean ` ** [ no] ** | Verify SVG |
43- | ` debug_flags ` | ` array ` * (space-separated)* ** [ ] ** * {"--cakeday", "--hireable", "--halloween", "--error"}* | Debug flags |
44- | ` dryrun ` | ` boolean ` ** [ no] ** | Enable dry-run |
45- | ` experimental_features ` | ` array ` * (space-separated)* ** [ ] ** * {"--optimize-svg"}* | Experimental features |
46- | ` use_mocked_data ` | ` boolean ` ** [ no] ** | Use mocked data instead of live APIs |
47- | ` use_prebuilt_image ` | ` boolean ` ** [ yes] ** | Use pre-built image from GitHub registry |
4840| ` delay ` | ` number ` ** [ 0] ** * {0 ≤ 𝑥 ≤ 3600}* | Use this to avoid triggering abuse mechanics on large workflows |
41+ | ` use_prebuilt_image ` | ` boolean ` ** [ yes] ** | Use pre-built image from GitHub registry |
42+ | ` plugins_errors_fatal ` <sup >🔧</sup > | ` boolean ` ** [ no] ** | Die on plugins errors |
43+ | ` debug ` <sup >🔧</sup > | ` boolean ` ** [ no] ** | Debug logs |
44+ | ` verify ` <sup >🔧</sup > | ` boolean ` ** [ no] ** | Verify SVG |
45+ | ` debug_flags ` <sup >🔧</sup > | ` array ` * (space-separated)* ** [ ] ** * {"--cakeday", "--hireable", "--halloween", "--error"}* | Debug flags |
46+ | ` dryrun ` <sup >🔧</sup > | ` boolean ` ** [ no] ** | Enable dry-run |
47+ | ` experimental_features ` <sup >🔧</sup > | ` array ` * (space-separated)* ** [ ] ** * {"--optimize-svg"}* | Experimental features |
48+ | ` use_mocked_data ` <sup >🔧</sup > | ` boolean ` ** [ no] ** | Use mocked data instead of live APIs |
4949
5050
5151Legend for option icons:
52+ * ✔️ Value must be provided
5253* 🔐 Value should be stored in repository secrets
53- * ✨ New feature currently in testing on ` master ` /` main `
54+ * ⏭️ Value be inherited by its related plugin-level option
55+ * 🔧 For development purposes, use with caution
56+ * 🧰 Must be enabled in ` settings.json ` (for web instances)
5457<!-- /options-->
5558
5659* [ → Full specification] ( metadata.yml ) *
0 commit comments