Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JulienKode/pull-request-name-linter-action
⚡️ Lint pull request name with commit lint. This is useful if you squash merge your pull requests ⚡️
https://github.com/JulienKode/pull-request-name-linter-action
actions best-practice best-practices ci commitlint continuous-integration github github-actions linter productivity pull-requests squash workflow
Last synced: 6 days ago
JSON representation
⚡️ Lint pull request name with commit lint. This is useful if you squash merge your pull requests ⚡️
- Host: GitHub
- URL: https://github.com/JulienKode/pull-request-name-linter-action
- Owner: JulienKode
- License: mit
- Created: 2020-01-20T20:04:11.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T18:44:20.000Z (10 days ago)
- Last Synced: 2024-10-29T20:41:24.220Z (10 days ago)
- Topics: actions, best-practice, best-practices, ci, commitlint, continuous-integration, github, github-actions, linter, productivity, pull-requests, squash, workflow
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/pull-request-linter-action
- Size: 154 MB
- Stars: 78
- Watchers: 2
- Forks: 13
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-actions - Lint pull request name with commitlint (Awesome if you squash merge !)
- fucking-awesome-actions - Lint pull request name with commitlint (Awesome if you squash merge !)
- awesome-workflows - Lint pull request name with commitlint (Awesome if you squash merge !)
README
# ⚡️ Pull request name linter with commitlint ⚡️
---
[![build](https://github.com/JulienKode/pull-request-name-linter-action/workflows/build/badge.svg)](https://github.com/JulienKode/pull-request-name-linter-action/actions)
[![GitHub issues](https://img.shields.io/github/issues/JulienKode/pull-request-name-linter-action?style=flat-square)](https://github.com/JulienKode/pull-request-name-linter-action/issues)
[![GitHub forks](https://img.shields.io/github/forks/JulienKode/pull-request-name-linter-action?style=flat-square)](https://github.com/JulienKode/pull-request-name-linter-action/network)
[![GitHub stars](https://img.shields.io/github/stars/JulienKode/pull-request-name-linter-action?style=flat-square)](https://github.com/JulienKode/pull-request-name-linter-action/stargazers)
[![GitHub license](https://img.shields.io/github/license/JulienKode/pull-request-name-linter-action?style=flat-square)](https://github.com/JulienKode/pull-request-name-linter-action/blob/master/LICENSE)
[![Watch on GitHub](https://img.shields.io/github/watchers/JulienKode/pull-request-name-linter-action.svg?style=social)](https://github.com/JulienKode/pull-request-name-linter-action/watchers)
[![Tweet](https://img.shields.io/twitter/url/https/github.com/JulienKode/pull-request-name-linter-action.svg?style=social)](https://twitter.com/intent/tweet?text=Checkout%20this%20library%20https%3A%2F%2Fgithub.com%2FJulienKode%2Fpull-request-name-linter-action)
---**GitHub action** to automatically **lint pull request name** with [**commitlint**](https://commitlint.js.org).
This is useful if squash merge your pull request for example.**Note**: If you are looking to lint the commits of your pull request with commitlint you can use [commitlint-github-action](https://github.com/wagoid/commitlint-github-action)
This package are using the commitlint 11 version
## Configuration
## Usage
### Create `.github/workflows/pr-name.yml`
Create a workflow (eg: `.github/workflows/pr-name.yml` see [Creating a Workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file)).
Here is an example of configuration```yaml
name: pr-name-linter
on:
pull_request:
types: ['opened', 'edited', 'reopened', 'synchronize']jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Install Dependencies
run: npm install @commitlint/config-conventional
- uses: JulienKode/[email protected]
```**Note**: make sure you install your dependencies that commitlint use
## Example
If you want to see an example of usage you can checkout this repository: https://github.com/JulienKode/pull-request-name-linter-action-example
![image](https://user-images.githubusercontent.com/7658664/80835181-8a7cc280-8bf2-11ea-932b-7a954db6bf60.png)