docs: update templates #5
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
| --- | |
| ##################### | |
| ## Run Semantic PR ## | |
| ##################### | |
| # | |
| # Documentation: | |
| # https://help.github.com/en/articles/workflow-syntax-for-github-actions | |
| # | |
| name: Semantic PR | |
| on: | |
| pull_request: | |
| types: [ opened, edited, synchronize ] | |
| ########################## | |
| # Prevent duplicate jobs # | |
| ########################## | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| ############### | |
| # Run the job # | |
| ############### | |
| jobs: | |
| ############### | |
| # Semantic PR # | |
| ############### | |
| semantic-pr: | |
| name: Validate PR | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| ############ | |
| # Check PR # | |
| ############ | |
| - name: Check PR | |
| id: lint-pr-title | |
| uses: amannn/[email protected] | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| ############################# | |
| # Add PR comment with error # | |
| ############################# | |
| - name: Add PR error comment | |
| uses: marocchino/[email protected] | |
| if: always() && (steps.lint-pr-title.outputs.error_message != null) | |
| with: | |
| header: pr-title-lint-error | |
| message: | | |
| 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 PR comment with error # | |
| ################################ | |
| - name: Delete PR error comment | |
| uses: marocchino/[email protected] | |
| if: ${{ steps.lint_pr_title.outputs.error_message == null }} | |
| with: | |
| header: pr-title-lint-error | |
| delete: true |