Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/actions-ecosystem/action-lint-commits
🔍 GitHub Action to lint commits on a pull request
https://github.com/actions-ecosystem/action-lint-commits
actions commit github lint
Last synced: about 1 month ago
JSON representation
🔍 GitHub Action to lint commits on a pull request
- Host: GitHub
- URL: https://github.com/actions-ecosystem/action-lint-commits
- Owner: actions-ecosystem
- License: apache-2.0
- Created: 2020-11-15T11:15:13.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-23T09:02:07.000Z (almost 2 years ago)
- Last Synced: 2024-11-11T17:04:24.749Z (2 months ago)
- Topics: actions, commit, github, lint
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/actions-ecosystem-action-lint-commits
- Size: 335 KB
- Stars: 14
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - actions-ecosystem/action-lint-commits - 🔍 GitHub Action to lint commits on a pull request (TypeScript)
README
# Action Lint Commits
[![actions-workflow-test][actions-workflow-test-badge]][actions-workflow-test]
[![release][release-badge]][release]
[![license][license-badge]][license]
This is a GitHub Action to lint commits on a pull request based one regex.
It's designed to work with other GitHub Actions so that you can flexibly build your workflow like posting warning comments in GitHub issues, Slack, and anything.
## Inputs
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
| -------------- | --------------------------------------------------------------------------------------------------- | -------- | -------- | ------- |
| `github_token` | A GitHub token. | `string` | `true` | `N/A` |
| `regex` | The regex for commit messages. | `string` | `true` | `N/A` |
| `format` | The output format of `outputs.{matched_commits,unmatched_commits}` in ['markdown', 'json', 'yaml']. | `string` | `true` | `N/A` |
## Outputs
| NAME | DESCRIPTION | TYPE |
| ------------------- | --------------------------------------------- | -------- |
| `matched_commits` | The commits which match `inputs.regex`. | `string` |
| `unmatched_commits` | The commits which don't match `inputs.regex`. | `string` |
You would pass the outputs to the inputs of other GitHub Actions to use the result of lint.
### Output Examples
format='markdown'
```markdown
- [`sha1xxxx`](https://github.com/owner/repo/commit/sha1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx): message 1
- [`sha2xxxx`](https://github.com/owner/repo/commit/sha2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx): message 2
- [`sha3xxxx`](https://github.com/owner/repo/commit/sha3xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx): message 3
```
format='json'
```json
[
{
"message": "message 1",
"sha": "sha1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"url": "https://github.com/owner/repo/commit/sha1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
},
{
"message": "message 2",
"sha": "sha2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"url": "https://github.com/owner/repo/commit/sha2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
},
{
"message": "message 3",
"sha": "sha3xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"url": "https://github.com/owner/repo/commit/sha3xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
]
```
format='yaml'
```yaml
- message: "message 1"
sha: "sha1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
url: "https://github.com/owner/repo/commit/sha1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
- message: "message 2"
sha: "sha2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
url: "https://github.com/owner/repo/commit/sha2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
- message: "message 3"
sha: "sha3xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
url: "https://github.com/owner/repo/commit/sha3xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
```
## Example
```yaml
name: Lint Commits
on:
pull_request_target:
types: ["opened", "reopened", "synchronize"]
jobs:
lint_commits:
runs-on: ubuntu-latest
steps:
- name: Lint commits
uses: actions-ecosystem/action-lint-commits@v1
id: lint-commits
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
regex: '^\w+\(.+\): .+' # e.g.) "feat(api): Add /users/get"
format: markdown
- name: Post warning comment
uses: actions-ecosystem/action-create-comment@v1
if: ${{ steps.lint-commits.outputs.unmatched_commits != '' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
body: |
The following commits needs their message changes:
${{ steps.lint-commits.outputs.unmatched_commits }}
The format `(): ` (`^\w+\(.+\): .+`) is acceptable. e.g., `feat(api): Add /users/get`
- name: Fail when commits don't pass lint
if: ${{ steps.lint-commits.outputs.unmatched_commits != '' }}
run: exit 1
```
## License
Copyright 2020 The Actions Ecosystem Authors.
Action Lint Commits is released under the [Apache License 2.0](./LICENSE).
[actions-workflow-test]: https://github.com/actions-ecosystem/action-lint-commits/actions?query=workflow%3ATest
[actions-workflow-test-badge]: https://img.shields.io/github/workflow/status/actions-ecosystem/action-lint-commits/Test?label=Test&style=for-the-badge&logo=github
[release]: https://github.com/actions-ecosystem/action-lint-commits/releases
[release-badge]: https://img.shields.io/github/v/release/actions-ecosystem/action-lint-commits?style=for-the-badge&logo=github
[license]: LICENSE
[license-badge]: https://img.shields.io/github/license/actions-ecosystem/action-lint-commits?style=for-the-badge