scorecard-monitor/action.yml at main · ossf/scorecard-monitor · GitHub

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
name: 'OpenSSF Scorecard Monitor'
description: 'Monitor OpenSSF Scorecard evolution over time'
author: 'OpenSSF Scorecard Authors'

inputs:
  scope:
    description: 'File that includes the list of repositories to monitor. Required when not using local-results-path.'
    required: false
  database:
    description: 'File that stores the state of the scorecard'
    required: true
  report:
    description: 'File that stores the report of the scorecard'
    required: true
  auto-commit:
    description: 'Automatically commit the changes to the repository'
    required: false
  auto-push:
    description: 'Automatically push the changes to the repository'
    required: false
  generate-issue:
    description: 'Automatically generate an issue with the discrepancies'
    required: false
  issue-title:
    description: 'Title of the issue to be generated'
    required: false
    default: "OpenSSF Scorecard Report Updated!"
  issue-assignees:
    description: 'List of assignees for the issue to be generated'
    required: false
  issue-labels:
    description: 'List of labels for the issue to be generated'
    required: false
  discovery-enabled:
    description: 'Enable the automatic update of the scope file'
    required: false
  discovery-orgs:
    description: 'List of organizations to be included in the scope file'
    required: false
  report-tags-enabled:
    description: 'Enable the use of tags in the report'
    required: false
  report-start-tag:
    description: 'Start tag to be used in the report'
    required: false
    default: "<!-- OPENSSF-SCORECARD-MONITOR:START -->"
  report-end-tag:
    description: 'End tag to be used in the report'
    required: false
    default: "<!-- OPENSSF-SCORECARD-MONITOR:END -->"
  github-token:
    description: 'Token to access the repository'
    required: true
  max-request-in-parallel:
    description: 'Maximum number of HTTP requests to be executed in parallel'
    required: false
    default: "10"
  render-badge:
    description: 'Render the OpenSSF Scorecard badge in the report'
    required: false
    default: "false"
  report-tool:
    description: 'Tool to be included as link in the report'
    required: false
    default: "scorecard-visualizer"
  results-path:
    description: >-
      Path to a Scorecard results JSON file. When provided, scores are
      read from this file instead of the public Scorecard API. The file
      should contain an array of Scorecard JSON v2 result objects (e.g.,
      from scorecard --format=json2, scorecard --org, or Allstar).
      When set, the scope input is not required.
    required: false

outputs:
  scores:
    description: 'Score data in JSON format'

runs:
  using: 'node24'
  main: 'dist/index.js'

# https://actions-cool.github.io/github-action-branding/
branding:
  icon: 'clipboard'
  color: 'red'