This action creates annotations from a JSON file.
In order to use this action, you will need to generate a JSON file using the following format (all options from https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#annotations-items are also supported and it's recommended to use them):
[
{
file: "path/to/file.js",
line: 5,
title: "title for my annotation",
message: "my message",
annotation_level: "failure"
}
]Required Token used to interact with the GitHub API.
Required Path to a JSON file which contains a list of annotations.
Optional Title of the check. Default: "check".
Optional Ignore errors when the provided repo-token does not have write permissions. Default: "false".
Optional Ignore if the file which contains annotations is missing. Default: "true".
Optional Commit SHA to which annotations are published.
- name: Annotate
uses: yuzutech/[email protected]
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
title: 'lint'
input: './annotations.json'