Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/conventional-changelog/commitlint-orb
https://github.com/conventional-changelog/commitlint-orb
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/conventional-changelog/commitlint-orb
- Owner: conventional-changelog
- License: mit
- Created: 2021-07-23T13:17:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-16T06:10:57.000Z (8 months ago)
- Last Synced: 2024-05-28T23:53:49.479Z (6 months ago)
- Language: Shell
- Size: 36.1 KB
- Stars: 2
- Watchers: 10
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# commitlint orb
[](https://circleci.com/gh/conventional-changelog/commitlint-orb) [](https://circleci.com/orbs/registry/orb/conventional-changelog/commitlint) [](https://raw.githubusercontent.com/conventional-changelog/commitlint-orb/master/LICENSE) [](https://discuss.circleci.com/c/ecosystem/orbs)
Lint your commit messages in a CircleCI job.
Add this orb's `commitlint/lint` job to your existing CircleCI workflow to utilize [commitlint](https://github.com/conventional-changelog/commitlint) for validating commit messages against the [conventional commit format](https://conventionalcommits.org/).
## Example
This example shows importing the `commitlint` orb into a basic CircleCI 2.1 config file, and adding the `commitlint/lint` job to a workflow. This configuration will lint every commit pushed to the repository.
```yaml
version: 2.1
orbs:
# Use the latest version of the orb.
# See the Orb Registry, or GitHub Releases
commitlint: conventional-changelog/commitlint@
workflows:
my-workflow:
jobs:
- commitlint/lint
```
CircleCI will report back the status of the `commitlint/lint` job and block a Pull Request from being merged if the job fails.
## Run the commitlint orb locally
Want to test out the commitlint orb in your CI pipeline before pushing your changes? Use the CircleCI CLI to run any job defined in your `.circleci/config.yml` locally, including jobs from orbs.
Assuming your config file looks similar to the example above, and you have the [CircleCI CLI](https://circleci.com/docs/2.0/local-cli/) installed, you can run this orb for the current project locally with the following command.
```shell
circleci local execute --job commitlint/lint
```
## Resources
[CircleCI Orb Registry Page](https://circleci.com/orbs/registry/orb/conventional-changelog/commitlint-orb) - The official registry page of this orb for all versions, executors, commands, and jobs described.
[CircleCI Orb Docs](https://circleci.com/docs/2.0/orb-intro/#section=configuration) - Docs for using and creating CircleCI Orbs.
### How to Contribute
We welcome [issues](https://github.com/conventional-changelog/commitlint-orb/issues) to and [pull requests](https://github.com/conventional-changelog/commitlint-orb/pulls) against this repository!
### How to Publish
* Create and push a branch with your new features.
* When ready to publish a new production version, create a Pull Request from _feature branch_ to `master`.
* The title of the pull request must contain a special semver tag: `[semver:]` where `` is replaced by one of the following values.
| Increment | Description|
| ----------| -----------|
| major | Issue a 1.0.0 incremented release|
| minor | Issue a x.1.0 incremented release|
| patch | Issue a x.x.1 incremented release|
| skip | Do not issue a release|
Example: `[semver:major]`
* Squash and merge. Ensure the semver tag is preserved and entered as a part of the commit message.
* On merge, after manual approval, the orb will automatically be published to the Orb Registry.
For further questions/comments about this or other orbs, visit the Orb Category of [CircleCI Discuss](https://discuss.circleci.com/c/orbs).