binary-scan/action.yml at main · FiniteStateInc/binary-scan · 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
name: 'Finite State Binary Scan'
description:
  'Upload a binary to the Finite State Platform to conduct a Quick Scan or full
  analysis.'
branding:
  icon: 'upload-cloud'
  color: 'orange'
inputs:
  finite-state-client-id: # id of input
    description: 'Finitestate API client ID.'
    required: true
  finite-state-secret:
    description: 'Finitestate API secret.'
    required: true
  finite-state-organization-context:
    description:
      'Organization context. This is provided by the Finite State API
      management. It looks like "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx".'
    required: true
  asset-id:
    description:
      'Asset ID for the asset that the new asset version will belong to.'
    required: true
  version:
    description: 'The name of the asset version that will be created.'
    required: true
  file-path:
    description: 'Local path of the file to be uploaded.'
    required: true
  quick-scan:
    description:
      Boolean that uploads the file for quick scan when true. Defaults to true
      (Quick Scan). For details about the contents of the Quick Scan vs. the
      Full Scan, please see the API documentation.
    required: true
    default: true
  automatic-comment:
    description:
      Defaults to false. If it is true, it will generate a comment in the PR
      with the link to the Asset version URL in Finite State.
    required: false
    default: false
  github-token:
    description:
      Token used to generate comment in a pr. Only required if automatic-comment
      input is true.
    required: false
  business-unit-id:
    description:
      '(optional) ID of the business unit that the asset version will belong to.
      If not provided, the asset version will adopt the existing business unit
      of the asset.'
    required: false
  created-by-user-id:
    description:
      '(optional) ID of the user to be recorded as the "Created By User" on the
      asset version. If not provided, the version will adopt the existing value
      of the asset.'
    required: false
  product-id:
    description:
      '(optional) ID of the product that the asset version will belong to. If
      not provided, the existing product for the asset will be used, if
      applicable.'
    required: false
  artifact-description:
    description:
      '(optional) Description of the artifact. If not provided, the default is
      "Firmware Binary".'
    required: false
outputs:
  response:
    description: 'Response from Finite State servers.'
  error:
    description:
      'Error message or details on why the action fails, if applicable.'
  asset-version-url:
    description: 'Finite State binary analysis URL for the file uploaded.'

runs:
  using: node20
  main: dist/index.js