mirror of
https://github.com/ivuorinen/actions.git
synced 2026-01-26 03:23:59 +00:00
Ismo Vuorinen
7061aafd35
* docs: update documentation * feat: validate-inputs has it's own pyproject * security: mask DOCKERHUB_PASSWORD * chore: add tokens, checkout, recrete docs, integration tests * fix: add `statuses: write` permission to pr-lint
51 lines
1.3 KiB
Markdown
51 lines
1.3 KiB
Markdown
# ivuorinen/actions/pr-lint
|
|
|
|
## PR Lint
|
|
|
|
### Description
|
|
|
|
Runs MegaLinter against pull requests
|
|
|
|
### Inputs
|
|
|
|
| name | description | required | default |
|
|
|------------|----------------------------------------|----------|-----------------------------|
|
|
| `token` | <p>GitHub token for authentication</p> | `false` | `""` |
|
|
| `username` | <p>GitHub username for commits</p> | `false` | `github-actions` |
|
|
| `email` | <p>GitHub email for commits</p> | `false` | `github-actions@github.com` |
|
|
|
|
### Outputs
|
|
|
|
| name | description |
|
|
|---------------------|----------------------------------------------------|
|
|
| `validation_status` | <p>Overall validation status (success/failure)</p> |
|
|
| `errors_found` | <p>Number of linting errors found</p> |
|
|
|
|
### Runs
|
|
|
|
This action is a `composite` action.
|
|
|
|
### Usage
|
|
|
|
```yaml
|
|
- uses: ivuorinen/actions/pr-lint@main
|
|
with:
|
|
token:
|
|
# GitHub token for authentication
|
|
#
|
|
# Required: false
|
|
# Default: ""
|
|
|
|
username:
|
|
# GitHub username for commits
|
|
#
|
|
# Required: false
|
|
# Default: github-actions
|
|
|
|
email:
|
|
# GitHub email for commits
|
|
#
|
|
# Required: false
|
|
# Default: github-actions@github.com
|
|
```
|