Semantic Release #2
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: 'Semantic Release' | |
on: | |
pull_request_target: | |
types: | |
- opened | |
- edited | |
- synchronize | |
- labeled | |
- unlabeled | |
jobs: | |
title: | |
name: Conventional Commits | |
runs-on: ubuntu-latest | |
steps: | |
- uses: amannn/action-semantic-pull-request@c3cd5d1ea3580753008872425915e343e351ab54 # v5 | |
id: lint_pr_title | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
with: | |
# Since we use `conventionalcommits` preset for | |
# `@semantic-release/commit-analyzer`, this list has to match allowed types | |
# Ref: https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.2.0/README.md#types | |
types: | | |
feat | |
fix | |
chore | |
docs | |
style | |
refactor | |
perf | |
test | |
revert | |
requireScope: false | |
subjectPattern: ^(?![A-Z]).+$ | |
subjectPatternError: | | |
The subject "{subject}" found in the pull request title "{title}" | |
didn't match the configured pattern. Please ensure that the subject | |
doesn't start with an uppercase character. | |
ignoreLabels: | | |
ignore-semantic-pull-request | |
# For work-in-progress PRs you can typically use draft pull requests | |
# from GitHub. However, private repositories on the free plan don't have | |
# this option and therefore this action allows you to opt-in to using the | |
# special "[WIP]" prefix to indicate this state. This will avoid the | |
# validation of the PR title and the pull request checks remain pending. | |
# Note that a second check will be reported if this is enabled. | |
wip: true | |
- uses: marocchino/sticky-pull-request-comment@efaaab3fd41a9c3de579aba759d2552635e590fd # 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. | |
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@efaaab3fd41a9c3de579aba759d2552635e590fd # v2 | |
with: | |
header: pr-title-lint-error | |
delete: true |