https://github.com/ahmadnassri/action-commit-lint
commitlint your PRs with a default configuration auto applied
https://github.com/ahmadnassri/action-commit-lint
action commitlint github
Last synced: 10 months ago
JSON representation
commitlint your PRs with a default configuration auto applied
- Host: GitHub
- URL: https://github.com/ahmadnassri/action-commit-lint
- Owner: ahmadnassri
- License: mit
- Created: 2020-08-13T03:54:17.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-02T21:54:44.000Z (12 months ago)
- Last Synced: 2025-04-30T15:18:11.365Z (10 months ago)
- Topics: action, commitlint, github
- Language: JavaScript
- Homepage:
- Size: 3.24 MB
- Stars: 7
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Action: commitlint
commitlint as a GitHub Action
[![license][license-img]][license-url]
[![release][release-img]][release-url]
## Usage
###### simple
``` yaml
name: commit-lint
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: ahmadnassri/action-commit-lint@v2
```
###### use different built-in config
``` yaml
name: commit-lint
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: ahmadnassri/action-commit-lint@v2
with:
config: angular
```
###### use your own rules
``` yaml
name: commit-lint
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ahmadnassri/action-commit-lint@v2
with:
config: ./path/to/commitlint.config
```
> **Notes** *for custom rules*:
>
> - must use `action/checkout` first\_
> - `config` is relative to your repo's root
> - config file format must follow [`commitlint` configuration format][]
### Inputs & Outputs
| output | type | required | default | description |
|----------|--------|----------|----------------|-----------------------------------------------------------|
| `token` | input | ❌ | `-` | The GitHub token used to inspect the pull-request commits |
| `config` | input | ❌ | `conventional` | name of config to use, or path to config file |
| `report` | output | `N/A` | `-` | a JSON object with the full `commitlint` report data |
#### built-in configs
the following are available without any additional requirement
- [`angular-type-enum`][]
- [`angular`][]
- [`conventional`][]
- [`lerna-scopes`][]
- [`patternplate`][]
[`commitlint` configuration format]: https://commitlint.js.org/#/reference-configuration
[`angular-type-enum`]: https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-angular-type-enum
[`angular`]: https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-angular
[`conventional`]: https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional
[`lerna-scopes`]: https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-lerna-scopes
[`patternplate`]: https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-patternplate
----
> Author: [Ahmad Nassri](https://www.ahmadnassri.com/) •
> Twitter: [@AhmadNassri](https://twitter.com/AhmadNassri)
[license-url]: LICENSE
[license-img]: https://badgen.net/github/license/ahmadnassri/action-commit-lint
[release-url]: https://github.com/ahmadnassri/action-commit-lint/releases
[release-img]: https://badgen.net/github/release/ahmadnassri/action-commit-lint