build: Use commitlint to enfore conventional commits
#6
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
| # SPDX-FileCopyrightText: Copyright DB Netz AG and the capellambse contributors | |
| # SPDX-License-Identifier: CC0-1.0 | |
| name: commits | |
| on: | |
| pull_request: | |
| branches: [main] | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| jobs: | |
| conventional-commits: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install commitlint | |
| run: npm install -g @commitlint/cli | |
| - name: Validate commit messages | |
| id: conventional-commits | |
| env: | |
| SHA_FROM: ${{ github.event.pull_request.base.sha }} | |
| SHA_TO: ${{ github.event.pull_request.head.sha }} | |
| run: | | |
| delim="_EOF_$(uuidgen)" | |
| echo "validation-result<<$delim" >> "$GITHUB_OUTPUT" | |
| r=0 | |
| commitlint --from "$SHA_FROM" --to "$SHA_TO" >> "$GITHUB_OUTPUT" 2>&1 || r=$? | |
| echo "$delim" >> "$GITHUB_OUTPUT" | |
| exit $r | |
| - name: Post comment if validation failed | |
| if: always() && steps.conventional-commits.outcome == 'failure' | |
| uses: actions/github-script@v6 | |
| env: | |
| TEXT: |- | |
| The pull request does not conform to the conventional commit specification. Please ensure that your commit messages follow the spec: | |
| <https://www.conventionalcommits.org/> | |
| We also strongly recommend that you set up your development environment with pre-commit, as described in our [CONTRIBUTING guidelines](https://github.com/DSD-DBS/py-capellambse/blob/master/CONTRIBUTING.rst). This will run all the important checks right before you commit your changes, and avoids lengthy CI wait time and round trips. | |
| The following commits failed to validate: | |
| ``` | |
| ${{ steps.conventional-commits.outputs.validation-result }} | |
| ``` | |
| Here are some examples of valid commit messages: | |
| ``` | |
| feat(model): Add realized_states to State and Mode | |
| fix(aird): Fix ZeroDivisionError with zero-sized circles | |
| docs(readme): Update project description | |
| ``` | |
| with: | |
| script: | | |
| github.rest.issues.createComment({ | |
| issue_number: context.issue.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| body: process.env.TEXT | |
| }) |