ci(root): Better readability of PR title linting comment #172
Workflow file for this run
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: "Lint PR title" | |
| on: | |
| pull_request_target: | |
| types: | |
| - opened | |
| - edited | |
| - synchronize | |
| # Use the following event if you want edit and test setting regarding conventional commits | |
| # pull_request: | |
| # types: | |
| # - opened | |
| # - edited | |
| # - synchronize | |
| permissions: | |
| pull-requests: write | |
| jobs: | |
| main: | |
| name: Validate PR titles | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v3 | |
| - name: Generate scopes | |
| id: generate_scopes | |
| run: | | |
| scopes=$(pnpm m ls --json --depth=-1 | grep "name" | sed -e 's/.*\: \(.*\)/\1/' -e 's/@novu\///g' -e 's/[",]//g') | |
| echo 'SCOPES<<EOF' >> $GITHUB_ENV | |
| echo "$scopes" >> $GITHUB_ENV | |
| echo 'EOF' >> $GITHUB_ENV | |
| - uses: amannn/action-semantic-pull-request@v5 | |
| id: lint_pr_title | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| requireScope: true | |
| scopes: | | |
| ${{ env.SCOPES }} | |
| - 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 PR title is: `${{ github.event.pull_request.title }}` | |
| It should be something like: `feat(scope): Add fancy new feature` | |
| **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 |