2022-05-29 20:06:59 +00:00
|
|
|
---
|
|
|
|
properties:
|
2022-11-24 14:09:24 +00:00
|
|
|
- name: api_key
|
2024-01-03 21:49:33 +00:00
|
|
|
description: |
|
|
|
|
Personal access token to access the GitHub API.
|
2022-05-29 20:06:59 +00:00
|
|
|
type: string
|
2022-05-29 20:18:37 +00:00
|
|
|
required: true
|
2022-05-29 20:06:59 +00:00
|
|
|
|
2022-11-24 14:09:24 +00:00
|
|
|
- name: base_url
|
2024-01-03 21:49:33 +00:00
|
|
|
description: |
|
|
|
|
Api url.
|
|
|
|
|
|
|
|
Only need to be changed for GitHub enterprise in most cases.
|
2022-05-29 20:06:59 +00:00
|
|
|
type: string
|
2024-01-03 22:26:15 +00:00
|
|
|
defaultValue: "https://api.github.com/"
|
2022-05-29 20:06:59 +00:00
|
|
|
required: false
|
|
|
|
|
2022-11-24 14:09:24 +00:00
|
|
|
- name: key
|
2024-01-03 21:49:33 +00:00
|
|
|
description: |
|
|
|
|
Unique identifier to assign to a comment.
|
|
|
|
|
|
|
|
The identifier is used to update an existing comment.
|
2022-05-29 20:06:59 +00:00
|
|
|
type: string
|
|
|
|
required: false
|
|
|
|
|
2022-11-24 14:09:24 +00:00
|
|
|
- name: message
|
2024-01-03 21:49:33 +00:00
|
|
|
description: |
|
|
|
|
Path to file or string that contains the comment text.
|
2022-05-29 20:06:59 +00:00
|
|
|
type: string
|
2022-05-29 20:18:37 +00:00
|
|
|
required: true
|
2022-05-29 20:06:59 +00:00
|
|
|
|
2024-01-03 21:49:33 +00:00
|
|
|
- name: skip_missing
|
|
|
|
description: |
|
|
|
|
Skip comment creation if the given message file does not exist.
|
2022-05-29 20:06:59 +00:00
|
|
|
type: bool
|
2024-01-03 22:26:15 +00:00
|
|
|
defaultValue: false
|
2022-05-29 20:06:59 +00:00
|
|
|
required: false
|
|
|
|
|
2024-01-03 21:49:33 +00:00
|
|
|
- name: update
|
|
|
|
description: |
|
|
|
|
Enable update of an existing comment that matches the key.
|
2022-05-29 20:06:59 +00:00
|
|
|
type: bool
|
2024-01-03 22:26:15 +00:00
|
|
|
defaultValue: false
|
2022-05-29 20:06:59 +00:00
|
|
|
required: false
|