chore: fix spelling of backend hierarchy docs file #8916
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: Conventional commits check | |
| on: | |
| # runs on `pull_request_target` events so that commenting on the PR is allowed | |
| pull_request_target: | |
| types: [opened, edited, synchronize, reopened] | |
| jobs: | |
| commitlint: | |
| name: Check PR title conforms to semantic-release | |
| runs-on: ubuntu-latest | |
| permissions: | |
| issues: write | |
| pull-requests: write | |
| steps: | |
| - name: install node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| - name: checkout code to pick up commitlint configuration | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| - name: install deps | |
| run: npm install "@commitlint/config-conventional" | |
| - name: run commitlint | |
| id: lint | |
| run: | | |
| failed=0 | |
| if ! npx commitlint --extends "@commitlint/config-conventional" --verbose <<< "$COMMIT_MSG"; then | |
| failed=1 | |
| fi | |
| echo "failed=$failed" >> "$GITHUB_OUTPUT" | |
| env: | |
| COMMIT_MSG: | | |
| ${{ github.event.pull_request.title }} | |
| ${{ github.event.pull_request.body }} | |
| - name: find existing comment | |
| if: steps.lint.outputs.failed == '1' | |
| uses: peter-evans/find-comment@v3 | |
| id: fc | |
| with: | |
| issue-number: ${{ github.event.pull_request.number }} | |
| body-includes: "ACTION NEEDED" | |
| - name: post a message if the pull request title and body fail `commitlint` | |
| if: steps.lint.outputs.failed == '1' && steps.fc.outputs.comment-body == '' | |
| uses: peter-evans/create-or-update-comment@v4 | |
| with: | |
| issue-number: ${{ github.event.pull_request.number }} | |
| body: | | |
| **ACTION NEEDED** | |
| Ibis follows the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) for release automation. | |
| The PR title and description are used as the merge commit message. | |
| Please update your PR title and description to match the specification. | |
| - name: fail the check if commitlint failed | |
| if: steps.lint.outputs.failed == '1' | |
| run: exit 1 # templating not allowed here it seems |