/
action.yml
1607 lines (1211 loc) · 41.4 KB
/
action.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# ====================================================================================
# Inputs and configuration
inputs:
# ====================================================================================
# 🗃️ Base content
base:
description: Base content
default: <default-value>
base_indepth:
description: Indepth mode
default: <default-value>
base_hireable:
description: Show `Available for hire!` in header section
default: <default-value>
base_skip:
description: Skip base content
default: <default-value>
repositories:
description: Fetched repositories
default: <default-value>
repositories_batch:
description: Fetched repositories per query
default: <default-value>
repositories_forks:
description: Include forks
default: <default-value>
repositories_affiliations:
description: Repositories affiliations
default: <default-value>
repositories_skipped:
description: Default skipped repositories
default: <default-value>
users_ignored:
description: Default ignored users
default: <default-value>
commits_authoring:
description: Identifiers that has been used for authoring commits
default: <default-value>
# ====================================================================================
# 🧱 Core
token:
description: GitHub Personal Access Token
required: true
user:
description: GitHub username
default: <default-value>
repo:
description: GitHub repository
default: <default-value>
committer_token:
description: GitHub Token used to commit metrics
default: ${{ github.token }}
committer_branch:
description: Target branch
default: <default-value>
committer_message:
description: Commit message
default: <default-value>
committer_gist:
description: Gist id
default: <default-value>
filename:
description: Output path
default: <default-value>
markdown:
description: Markdown template path
default: <default-value>
markdown_cache:
description: Markdown file cache
default: <default-value>
output_action:
description: Output action
default: <default-value>
output_condition:
description: Output condition
default: <default-value>
optimize:
description: Optimization features
default: <default-value>
setup_community_templates:
description: Community templates to setup
default: <default-value>
template:
description: Template
default: <default-value>
query:
description: Query parameters
default: <default-value>
extras_css:
description: Extra CSS
default: <default-value>
extras_js:
description: Extra JavaScript
default: <default-value>
github_api_rest:
description: GitHub REST API endpoint
default: <default-value>
github_api_graphql:
description: GitHub GraphQL API endpoint
default: <default-value>
config_timezone:
description: Timezone for dates
default: ""
config_order:
description: Plugin order
default: <default-value>
config_twemoji:
description: Use twemojis
default: <default-value>
config_gemoji:
description: Use GitHub custom emojis
default: <default-value>
config_octicon:
description: Use GitHub octicons
default: <default-value>
config_display:
description: Display width (for image output formats)
default: <default-value>
config_animations:
description: Use CSS animations
default: <default-value>
config_base64:
description: Base64-encoded images
default: <default-value>
config_padding:
description: Output padding
default: <default-value>
config_output:
description: Output format
default: <default-value>
config_presets:
description: Configuration presets
default: ""
retries:
description: Retries in case of failures (for rendering)
default: <default-value>
retries_delay:
description: Delay between each retry (in seconds, for rendering)
default: <default-value>
retries_output_action:
description: Retries in case of failures (for output action)
default: <default-value>
retries_delay_output_action:
description: Delay between each retry (in seconds, for output action)
default: <default-value>
clean_workflows:
description: Clean previous workflows jobs
default: <default-value>
delay:
description: Job delay
default: <default-value>
quota_required_rest:
description: Minimum GitHub REST API requests quota required to run
default: <default-value>
quota_required_graphql:
description: Minimum GitHub GraphQL API requests quota required to run
default: <default-value>
quota_required_search:
description: Minimum GitHub Search API requests quota required to run
default: <default-value>
notice_releases:
description: Notice about new releases of metrics
default: <default-value>
use_prebuilt_image:
description: >-
Use pre-built docker image from [GitHub container
registry](https://github.com/lowlighter/metrics/pkgs/container/metrics)
default: yes
plugins_errors_fatal:
description: Fatal plugin errors
default: <default-value>
debug:
description: Debug mode
default: <default-value>
verify:
description: SVG validity check
default: <default-value>
debug_flags:
description: Debug flags
default: <default-value>
debug_print:
description: Print output in console
default: <default-value>
dryrun:
description: Dry-run
default: <default-value>
experimental_features:
description: Experimental features
default: <default-value>
use_mocked_data:
description: Use mocked data instead of live APIs
default: <default-value>
# ====================================================================================
# 📅 Isometric commit calendar
plugin_isocalendar:
description: Enable isocalendar plugin
default: <default-value>
plugin_isocalendar_duration:
description: Time range
default: <default-value>
# ====================================================================================
# 🈷️ Languages activity
plugin_languages:
description: Enable languages plugin
default: <default-value>
plugin_languages_ignored:
description: Ignored languages
default: <default-value>
plugin_languages_skipped:
description: Skipped repositories
default: <default-value>
plugin_languages_limit:
description: Display limit
default: <default-value>
plugin_languages_threshold:
description: Display threshold (percentage)
default: <default-value>
plugin_languages_other:
description: Group unknown, ignored and over-limit languages into "Other" category
default: <default-value>
plugin_languages_colors:
description: Custom languages colors
default: <default-value>
plugin_languages_aliases:
description: Custom languages names
default: <default-value>
plugin_languages_sections:
description: Displayed sections
default: <default-value>
plugin_languages_details:
description: Additional details
default: <default-value>
plugin_languages_indepth:
description: Indepth mode
default: <default-value>
plugin_languages_indepth_custom:
description: Indepth mode - Custom repositories
default: <default-value>
plugin_languages_analysis_timeout:
description: Indepth mode - Analysis timeout
default: <default-value>
plugin_languages_analysis_timeout_repositories:
description: Indepth mode - Analysis timeout (repositories)
default: <default-value>
plugin_languages_categories:
description: Indepth mode - Displayed categories (most-used section)
default: <default-value>
plugin_languages_recent_categories:
description: Indepth mode - Displayed categories (recently-used section)
default: <default-value>
plugin_languages_recent_load:
description: Indepth mode - Events to load (recently-used section)
default: <default-value>
plugin_languages_recent_days:
description: Indepth mode - Events maximum age (day, recently-used section)
default: <default-value>
# ====================================================================================
# ✨ Stargazers
plugin_stargazers:
description: Enable stargazers plugin
default: <default-value>
plugin_stargazers_days:
description: Time range
default: <default-value>
plugin_stargazers_charts:
description: Charts
default: <default-value>
plugin_stargazers_charts_type:
description: Charts display type
default: <default-value>
plugin_stargazers_worldmap:
description: Stargazers worldmap
default: <default-value>
plugin_stargazers_worldmap_token:
description: Stargazers worldmap token
default: <default-value>
plugin_stargazers_worldmap_sample:
description: Stargazers worldmap sample
default: <default-value>
# ====================================================================================
# 👨💻 Lines of code changed
plugin_lines:
description: Enable lines plugin
default: <default-value>
plugin_lines_skipped:
description: Skipped repositories
default: <default-value>
plugin_lines_sections:
description: Displayed sections
default: <default-value>
plugin_lines_repositories_limit:
description: Display limit
default: <default-value>
plugin_lines_history_limit:
description: Years to display
default: <default-value>
plugin_lines_delay:
description: Delay before performing a second query
default: <default-value>
# ====================================================================================
# 📌 Starred topics
plugin_topics:
description: Enable topics plugin
default: <default-value>
plugin_topics_mode:
description: Display mode
default: <default-value>
plugin_topics_sort:
description: Sorting method
default: <default-value>
plugin_topics_limit:
description: Display limit
default: <default-value>
# ====================================================================================
# 🌟 Recently starred repositories
plugin_stars:
description: Enable stars plugin
default: <default-value>
plugin_stars_limit:
description: Display limit
default: <default-value>
# ====================================================================================
# 📜 Repository licenses
plugin_licenses:
description: Enable licenses plugin
default: <default-value>
plugin_licenses_setup:
description: Setup command
default: <default-value>
plugin_licenses_ratio:
description: Used licenses ratio
default: <default-value>
plugin_licenses_legal:
description: Permissions, limitations and conditions about used licenses
default: <default-value>
# ====================================================================================
# 💡 Coding habits and activity
plugin_habits:
description: Enable habits plugin
default: <default-value>
plugin_habits_from:
description: Events to use
default: <default-value>
plugin_habits_skipped:
description: Skipped repositories
default: <default-value>
plugin_habits_days:
description: Event maximum age
default: <default-value>
plugin_habits_facts:
description: Mildly interesting facts
default: <default-value>
plugin_habits_charts:
description: Charts
default: <default-value>
plugin_habits_charts_type:
description: Charts display type
default: <default-value>
plugin_habits_trim:
description: Trim unused hours on charts
default: <default-value>
plugin_habits_languages_limit:
description: Display limit (languages)
default: <default-value>
plugin_habits_languages_threshold:
description: Display threshold (percentage)
default: <default-value>
# ====================================================================================
# 🏅 Repository contributors
plugin_contributors:
description: Enable contributors plugin
default: <default-value>
plugin_contributors_base:
description: Base reference
default: <default-value>
plugin_contributors_head:
description: Head reference
default: <default-value>
plugin_contributors_ignored:
description: Ignored users
default: <default-value>
plugin_contributors_contributions:
description: Contributions count
default: <default-value>
plugin_contributors_sections:
description: Displayed sections
default: <default-value>
plugin_contributors_categories:
description: Contribution categories
default: <default-value>
# ====================================================================================
# 🎟️ Follow-up of issues and pull requests
plugin_followup:
description: Enable followup plugin
default: <default-value>
plugin_followup_sections:
description: Displayed sections
default: <default-value>
plugin_followup_indepth:
description: Indepth analysis
default: <default-value>
plugin_followup_archived:
description: Include archived repositories
default: <default-value>
# ====================================================================================
# 🎭 Comment reactions
plugin_reactions:
description: Enable reactions plugin
default: <default-value>
plugin_reactions_limit:
description: Display limit (issues and pull requests comments)
default: <default-value>
plugin_reactions_limit_issues:
description: Display limit (issues and pull requests, first comment)
default: <default-value>
plugin_reactions_limit_discussions:
description: Display limit (discussions, first comment)
default: <default-value>
plugin_reactions_limit_discussions_comments:
description: Display limit (discussions comments)
default: <default-value>
plugin_reactions_days:
description: Comments maximum age
default: <default-value>
plugin_reactions_display:
description: Display mode
default: <default-value>
plugin_reactions_details:
description: Additional details
default: <default-value>
plugin_reactions_ignored:
description: Ignored users
default: <default-value>
# ====================================================================================
# 🧑🤝🧑 People
plugin_people:
description: Enable people plugin
default: <default-value>
plugin_people_limit:
description: Display limit
default: <default-value>
plugin_people_identicons:
description: Force identicons pictures
default: <default-value>
plugin_people_identicons_hide:
description: Hide identicons pictures
default: <default-value>
plugin_people_size:
description: Profile picture display size
default: <default-value>
plugin_people_types:
description: Displayed sections
default: <default-value>
plugin_people_thanks:
description: Special thanks
default: <default-value>
plugin_people_sponsors_custom:
description: Custom sponsors
default: <default-value>
plugin_people_shuffle:
description: Shuffle data
default: <default-value>
# ====================================================================================
# 💝 GitHub Sponsorships
plugin_sponsorships:
description: Enable sponsorships plugin
default: <default-value>
plugin_sponsorships_sections:
description: Displayed sections
default: <default-value>
plugin_sponsorships_size:
description: Profile picture display size
default: <default-value>
# ====================================================================================
# 💕 GitHub Sponsors
plugin_sponsors:
description: Enable sponsors plugin
default: <default-value>
plugin_sponsors_sections:
description: Displayed sections
default: <default-value>
plugin_sponsors_past:
description: Past sponsorships
default: <default-value>
plugin_sponsors_size:
description: Profile picture display size
default: <default-value>
plugin_sponsors_title:
description: Title caption
default: <default-value>
# ====================================================================================
# 📓 Featured repositories
plugin_repositories:
description: Enable repositories plugin
default: <default-value>
plugin_repositories_featured:
description: Featured repositories
default: <default-value>
plugin_repositories_pinned:
description: Pinned repositories
default: <default-value>
plugin_repositories_starred:
description: Featured most starred repositories
default: <default-value>
plugin_repositories_random:
description: Featured random repositories
default: <default-value>
plugin_repositories_order:
description: Featured repositories display order
default: <default-value>
plugin_repositories_forks:
description: Include repositories forks
default: <default-value>
plugin_repositories_affiliations:
description: Repositories affiliations
default: <default-value>
# ====================================================================================
# 💬 Discussions
plugin_discussions:
description: Enable discussions plugin
default: <default-value>
plugin_discussions_categories:
description: Discussion categories
default: <default-value>
plugin_discussions_categories_limit:
description: Display limit (categories)
default: <default-value>
# ====================================================================================
# 💫 Star lists
plugin_starlists:
description: Enable starlists plugin
default: <default-value>
plugin_starlists_limit:
description: Display limit (star lists)
default: <default-value>
plugin_starlists_limit_repositories:
description: Display limit (repositories per star list)
default: <default-value>
plugin_starlists_languages:
description: Star lists languages statistics
default: <default-value>
plugin_starlists_limit_languages:
description: Display limit (languages per star list)
default: <default-value>
plugin_starlists_languages_ignored:
description: Ignored languages in star lists
default: <default-value>
plugin_starlists_languages_aliases:
description: Custom languages names in star lists
default: <default-value>
plugin_starlists_shuffle_repositories:
description: Shuffle data
default: <default-value>
plugin_starlists_ignored:
description: Skipped star lists
default: <default-value>
plugin_starlists_only:
description: Showcased star lists
default: <default-value>
# ====================================================================================
# 📆 Commit calendar
plugin_calendar:
description: Enable calendar plugin
default: <default-value>
plugin_calendar_limit:
description: Years to display
default: <default-value>
# ====================================================================================
# 🏆 Achievements
plugin_achievements:
description: Enable achievements plugin
default: <default-value>
plugin_achievements_threshold:
description: Rank threshold filter
default: <default-value>
plugin_achievements_secrets:
description: Secrets achievements
default: <default-value>
plugin_achievements_display:
description: Display style
default: <default-value>
plugin_achievements_limit:
description: Display limit
default: <default-value>
plugin_achievements_ignored:
description: Ignored achievements
default: <default-value>
plugin_achievements_only:
description: Showcased achievements
default: <default-value>
# ====================================================================================
# 🎩 Notable contributions
plugin_notable:
description: Enable notable plugin
default: <default-value>
plugin_notable_filter:
description: Query filter
default: <default-value>
plugin_notable_skipped:
description: Skipped repositories
default: <default-value>
plugin_notable_from:
description: Repository owner account type filter
default: <default-value>
plugin_notable_repositories:
description: Repository name
default: <default-value>
plugin_notable_indepth:
description: Indepth mode
default: <default-value>
plugin_notable_types:
description: Contribution types filter
default: <default-value>
plugin_notable_self:
description: Include own repositories
default: <default-value>
# ====================================================================================
# 📰 Recent activity
plugin_activity:
description: Enable activity plugin
default: <default-value>
plugin_activity_limit:
description: Display limit
default: <default-value>
plugin_activity_load:
description: Events to load
default: <default-value>
plugin_activity_days:
description: Events maximum age
default: <default-value>
plugin_activity_visibility:
description: Events visibility
default: <default-value>
plugin_activity_timestamps:
description: Events timestamps
default: <default-value>
plugin_activity_skipped:
description: Skipped repositories
default: <default-value>
plugin_activity_ignored:
description: Ignored users
default: <default-value>
plugin_activity_filter:
description: Events types
default: <default-value>
# ====================================================================================
# 🧮 Repositories traffic
plugin_traffic:
description: Enable traffic plugin
default: <default-value>
plugin_traffic_skipped:
description: Skipped repositories
default: <default-value>
# ====================================================================================
# ♐ Random code snippet
plugin_code:
description: Enable code plugin
default: <default-value>
plugin_code_lines:
description: Display limit (lines per code snippets)
default: <default-value>
plugin_code_load:
description: Events to load
default: <default-value>
plugin_code_days:
description: Events maximum age
default: <default-value>
plugin_code_visibility:
description: Events visibility
default: <default-value>
plugin_code_skipped:
description: Skipped repositories
default: <default-value>
plugin_code_languages:
description: Showcased languages
default: <default-value>
# ====================================================================================
# 🎫 Gists
plugin_gists:
description: Enable gists plugin
default: <default-value>
# ====================================================================================
# 🗂️ GitHub projects
plugin_projects:
description: Enable projects plugin
default: <default-value>
plugin_projects_limit:
description: Display limit
default: <default-value>
plugin_projects_repositories:
description: Featured repositories projects
default: <default-value>
plugin_projects_descriptions:
description: Projects descriptions
default: <default-value>
# ====================================================================================
# 🙋 Introduction
plugin_introduction:
description: Enable introduction plugin
default: <default-value>
plugin_introduction_title:
description: Section title
default: <default-value>
# ====================================================================================
# 🌇 GitHub Skyline
plugin_skyline:
description: Enable skyline plugin
default: <default-value>
plugin_skyline_year:
description: Displayed year
default: <default-value>
plugin_skyline_frames:
description: Frames count
default: <default-value>
plugin_skyline_quality:
description: Image quality
default: <default-value>
plugin_skyline_compatibility:
description: Compatibility mode
default: <default-value>
plugin_skyline_settings:
description: Advanced settings
default: <default-value>
# ====================================================================================
# 💭 GitHub Community Support
plugin_support:
description: Enable support plugin
default: <default-value>
# ====================================================================================
# ⏱️ Google PageSpeed
plugin_pagespeed:
description: Enable pagespeed plugin
default: <default-value>
plugin_pagespeed_token:
description: PageSpeed token
default: <default-value>
plugin_pagespeed_url:
description: Audited website
default: <default-value>
plugin_pagespeed_detailed:
description: Detailed results
default: <default-value>