Skip to content

Commit

Permalink
chore: add pr title check workflow (#123)
Browse files Browse the repository at this point in the history
# Description

Add PR Title check on PRs to ensure title follows Conventional Commits
standards.
  • Loading branch information
itsacoyote authored Jun 12, 2024
1 parent 2a80897 commit ec8df37
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions .github/workflows/check-pr-title.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
name: Validate PR title

on:
pull_request_target:
types:
- opened
- edited
- synchronize

permissions:
pull-requests: write

jobs:
main:
name: Validate PR title
runs-on: ubuntu-latest
steps:
- uses: amannn/[email protected]
id: lint_pr_title
env:
GITHUB_TOKEN: ${{ github.token }}
with:
types: |
fix
feat
docs
ci
chore
requireScope: false
wip: true

- uses: marocchino/[email protected]
# When the previous steps fails, the workflow would stop. By adding this
# condition you can continue the execution with the populated error message.
if: always() && (steps.lint_pr_title.outputs.error_message != null)
with:
header: pr-title-lint-error
message: |
Hey there and thank you for opening this pull request! 👋🏼
We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted.
If your PR is still a work in progress, please prefix the title with "[WIP]".
Details:
```
${{ steps.lint_pr_title.outputs.error_message }}
```
# Delete a previous comment when the issue has been resolved
- if: ${{ steps.lint_pr_title.outputs.error_message == null }}
uses: marocchino/[email protected]
with:
header: pr-title-lint-error
delete: true

0 comments on commit ec8df37

Please sign in to comment.