Skip to content

Commit

Permalink
ci: Make a comment when the PR title is wrongly formatted (#965)
Browse files Browse the repository at this point in the history
Prints a helpful message when the PR title does not follow the
conventional commits format.
The message gets deleted automatically once the title is fixed.


![image](https://github.com/CQCL/hugr/assets/121866228/9c56cf0d-bc08-4ad0-a95c-f67e71fd83af)
  • Loading branch information
aborgna-q authored Apr 23, 2024
1 parent 81d358f commit 6a9e6eb
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion .github/workflows/pr-title.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ on:
types: [checks_requested]

permissions:
pull-requests: read
pull-requests: write

jobs:
main:
Expand All @@ -25,6 +25,7 @@ jobs:
if: github.event_name == 'pull_request_target'
steps:
- uses: amannn/action-semantic-pull-request@v5
id: lint_pr_title
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
Expand Down Expand Up @@ -70,3 +71,36 @@ jobs:
# event triggers in your workflow.
ignoreLabels: |
ignore-semantic-pull-request
- uses: marocchino/sticky-pull-request-comment@v2
# 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.
Your title should look like this:
```
<type>(<scope>): <description>
```
Or like this, if it's a breaking change:
```
<type>!: <description>
```
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/sticky-pull-request-comment@v2
with:
header: pr-title-lint-error
delete: true

0 comments on commit 6a9e6eb

Please sign in to comment.