slackapi/slack-health-score
Report some code quality heuristics as defined by Slack Engineering
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| extension | File extension of files to filter on to report health score on. E.g. "js" or "go" | yes | — |
| github_token | A GitHub access token with permissions to write GitHub Checks. Recommended to set this to `secrets.GITHUB_TOKEN` in combination with using in a workflow `job` that has `checks: write` permissions. | yes | — |
| include | Only parse the specified files and directories (recursively). Defaults to `.`. E.g. "src" | no | — |
| exclude | Ignore the specified files and directories. Essentially a direct argument into `find` `-not -path "{arg}"`. Defaults to contents of `.gitignore`. E.g. "node_modules" | no | — |
| codecov_token | A CodeCov API access token with read permissions to the repo. This _cannot_ be a CodeCov "Global Upload" token - it _must_ be a human user API access token. Setting this will try to pull coverage information for the repo from CodeCov to include in health score calculation; not setting it will exclude code coverage from health score calculation. | no | — |
| codecov_max_attempts | Maximum number of times to try retrieving code coverage information from codecov. Defaults to 10. | no | — |
| codecov_retry_delay | Number of milliseconds to wait when retrying retrieving code coverage information from codecov. Defaults to 10000 (10 seconds). | no | — |
| codecov_treat_timeout_as_error | If retrieving code coverage from CodeCov times out (according to the configuration set up via the `codecov_max_attempts` and `codecov_retry_delay` inputs), should that cause this action to error out. Defaults to false. | no | — |
Outputs
no outputs