add-pr-comment/action.yml at main · step-security/add-pr-comment · 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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
name: "Add PR Comment"
description: "Add a comment to a pull request or commit"
inputs:
  message:
    description: "The message to print."
    required: false
  message-path:
    description: "A path or list of paths to a file to print as a message instead of a string."
    required: false
  attach-path:
    description: "A file path or glob pattern for files to upload as artifacts and link in the comment."
    required: false
  attach-name:
    description: "Name for the uploaded artifact. Defaults to pr-comment-attachments."
    default: "pr-comment-attachments"
    required: false
  attach-text:
    description: "Markdown text appended for attachments. Use %ARTIFACT_URL% as a placeholder for the download link."
    required: false
  message-id:
    description: "An optional id to use for this message."
    default: "add-pr-comment"
    required: false
  refresh-message-position:
    description: "If a message with the same id, this option allow to refresh the position of the message to be the last one posted."
    default: "false"
    required: false
  repo-owner:
    description: "The repo owner."
    default: "${{ github.repository_owner }}"
    required: false
  repo-name:
    description: "The repo name."
    default: "${{ github.event.repository.name }}"
    required: false
  repo-token:
    description: "A GitHub token for API access. Defaults to {{ github.token }}."
    default: "${{ github.token }}"
    required: false
  allow-repeats:
    description: "Allow messages to be repeated."
    default: "false"
    required: false
  proxy-url:
    description: "Proxy URL for comment creation"
    required: false
  status:
    description: "A job status for status headers. Defaults to {{ job.status }}."
    default: "${{ job.status }}"
    required: false
  message-success:
    description: "Override the message when a run is successful."
    required: false
  message-failure:
    description: "Override the message when a run fails."
    required: false
  message-cancelled:
    description: "Override the message when a run is cancelled."
    required: false
  message-skipped:
    description: "Override the message when a run is skipped."
    required: false
  issue:
    description: "Override the message when a run is cancelled."
    required: false
  update-only:
    description: "Only update the comment if it already exists."
    required: false
  preformatted:
    description: "Treat message text (from a file or input) as pre-formatted and place it in a codeblock."
    required: false
  truncate:
    description: 'Truncation mode when the message exceeds the safe comment length. "artifact" (default) uploads the full message as a downloadable artifact and links it. "simple" truncates with a notice.'
    default: "artifact"
    required: false
  truncate-separator:
    description: 'Custom separator inserted before the truncation notice. Defaults to "---".'
    required: false
  comment-target:
    description: 'Where to post the comment. Use "pr" for pull request/issue comments (default) or "commit" for commit comments.'
    default: "pr"
    required: false
  commit-sha:
    description: 'The commit SHA to comment on when comment-target is "commit". Defaults to the current commit.'
    required: false
  find:
    description: "A regular expression to find for replacement. Multiple lines become individual regular expressions."
  replace:
    description: "A replacement to use, overrides the message. Multple lines can replace same-indexed find patterns."
  delete-on-status:
    description: "Delete comment on specified status."
outputs:
  comment-created:
    description: "Whether a comment was created."
  comment-updated:
    description: "Whether a comment was updated."
  comment-id:
    description: "If a comment was created or updated, the comment id."
  artifact-url:
    description: "If files were attached, the URL to download the artifact."
  truncated:
    description: "Whether the message was truncated."
  truncated-artifact-url:
    description: "If the message was truncated in artifact mode, the URL to download the full message."
branding:
  icon: message-circle
  color: purple
runs:
  using: "node24"
  main: "dist/index.js"