grantbirki/auditor-action

The Auditor

Trust Signals

name	description	required	default
github_token	The GitHub token used to create an authenticated client - Provided for you by default! If you are using annotations on pull requests, you may need to use a GitHub App token with checks:write permissions instead	yes	${{ github.token }}
config	The path to the auditor's config file	yes	config/auditor.yml
json_diff_path	The path to the json diff file	yes	diff.json
github_base_url	The base URL for the GitHub instance you are using	yes	https://github.com
annotate_pr	Annotate the PR with the audit results	yes	true
annotate_name	The name of the annotation to name to use	yes	The Auditor
annotate_title	The title of the annotation to use	yes	The Auditor has detected findings in your pull request
annotate_summary	The summary of the annotation to use	yes	Please review the findings and make any necessary changes
annotate_status	The status of the annotation to use	yes	completed
write_results_path	The path to write the markdown results to (for custom reporting) - Leave unset to disable writing results to a file	yes	""
base_branch	The base branch to compare the PR against	yes	HEAD^1
file_output_only	Only output the diff to the json file	yes	true
search_path	The path to search for changes	yes	.
max_buffer_size	The maximum buffer size for the git diff command	yes	10000000

no outputs