{"repo":"wagoid/commitlint-github-action","free":true,"listed":false,"github":"https://github.com/wagoid/commitlint-github-action","clone":"git clone https://github.com/wagoid/commitlint-github-action.git","description":"Lints Pull Request commits with commitlint","language":"JavaScript","stars":401,"topics":["hacktoberfest","github-actions"],"license":"MIT","category":"dev-tools","readme_excerpt":"Commitlint Github Action Lints Pull Request commits with commitlint. Usage Create a GitHub workflow in the .github folder, e.g. .github/workflows/commitlint.yml : Alternatively, you can run on other event types such as on: [push] . In that case, the action will lint the push event's commit(s) instead of linting commits from a pull request. You can also combine push and pull request together in the same workflow. Using with GitHub Merge Queues GitHub's merge queue is a feature that allows you to queue pull requests for merging once they meet certain criteria. When using merge queues, you need to ensure that your workflows are set up to handle the merge group event, which is triggered when pull requests are added to the merge queue. Workflow Configuration To use the commitlint-github-action with merge queues, you need to set up a workflow that listens to the merge group event. Here's an example of how to configure your workflow: Important Note: To ensure that the merge group event triggers correctly, you need to have at least one workflow that responds to the pull request event with a job named the same as the one in your merge group workflow ( commitlint in this example). This is necessary because the merge queue relies on the existence of status checks from the pull request context. Here's a minimal pull request workflow to satisfy this requirement: This workflow can also be a meaningful one that checks out the commits in your PR and runs other checks, but it must have a job ","default_branch":null,"files":null,"tree":[],"storefront":"/r/wagoid","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/wagoid/commitlint-github-action/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}