2022-12-06 09:15:46 -05:00
name : "Conventional Commits PR Title"
on :
pull_request_target :
types :
- opened
- edited
- synchronize
jobs :
main :
name : Validate PR title
runs-on : ubuntu-latest
steps :
- uses : amannn/action-semantic-pull-request@v5
env :
GITHUB_TOKEN : ${{ secrets.PR_TITLE_TOKEN }}
2022-12-06 09:19:35 -05:00
- 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! 👋🏼
2022-12-12 11:02:47 -05:00
2022-12-06 09:19:35 -05:00
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.
Details :
2022-12-12 11:02:47 -05:00
2022-12-06 09:19:35 -05:00
```
${{ 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
2022-12-12 11:02:47 -05:00
with :
2022-12-06 09:19:35 -05:00
header : pr-title-lint-error
delete : true