grantbirki/auditor-action-core
The Auditor Action's Core
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| 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 }} |
| annotate_pr | Whether or not to annotate the PR with the audit results | no | true |
| github_base_url | The base URL for the GitHub instance you are using | yes | https://github.com |
| json_diff_path | The path to the JSON diff file to load | yes | diff.json |
| config_path | The path to the Auditor configuration file | yes | config/auditor.yml |
| 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 | no | "" |
Outputs
| name | description |
|---|---|
| passed | Whether or not the audit passed - 'true' or 'false' |
| violation_count | The number of violations found |
| requested_reviewers | The list of requested reviewers (if any) |