docs(patch): updating README to fix link to documentation #66
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: "PR title validation" | |
| on: | |
| pull_request_target: | |
| types: | |
| - opened | |
| - edited | |
| - synchronize | |
| jobs: | |
| main: | |
| name: Validate PR title | |
| # runs-on: [self-hosted, ubuntu-latest] | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 30 | |
| steps: | |
| - uses: amannn/action-semantic-pull-request@v5 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| # Configure which types are allowed. | |
| # Default: https://github.com/commitizen/conventional-commit-types | |
| types: | | |
| fix | |
| feat | |
| docs | |
| style | |
| refactor | |
| perf | |
| test | |
| build | |
| ci | |
| chore | |
| revert | |
| # Configure which scopes are allowed. | |
| scopes: | | |
| patch | |
| hotfix | |
| minor | |
| major | |
| # Configure that a scope must always be provided. | |
| requireScope: false | |
| # Configure which scopes are disallowed in PR titles. For instance by setting | |
| # the value below, `chore(release): ...` and `ci(e2e,release): ...` will be rejected. | |
| disallowScopes: | | |
| release | |
| # Configure additional validation for the subject based on a regex. | |
| # This example ensures the subject doesn't start with an uppercase character. | |
| #subjectPattern: ^.*\[sc-[0-9]+\].*$ | |
| #subjectPatternError: | | |
| # The pull request title should contain Shortcut case number like '[sc-123]' | |
| # If the PR contains one of these labels, the validation is skipped. | |
| # Multiple labels can be separated by newlines. | |
| # If you want to rerun the validation when labels change, you might want | |
| # to use the `labeled` and `unlabeled` event triggers in your workflow. | |
| ignoreLabels: | | |
| bot | |
| 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 |