docs: Upgrade instructions for use of new operator #136
Workflow file for this run
This file contains hidden or 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: "Validate PR Title" | |
| on: | |
| pull_request_target: | |
| types: [opened, edited, synchronize] | |
| jobs: | |
| main: | |
| name: Validate PR title | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: amannn/[email protected] | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| # Allowed types: https://github.com/commitizen/conventional-commit-types | |
| # build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | |
| # ci: Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs) | |
| # docs: Documentation only changes | |
| # feat: NOTABLE CHANGE: A new feature | |
| # fix: NOTABLE CHANGE: A bug fix | |
| # perf: A code change that improves performance | |
| # refactor: A code change that neither fixes a bug nor adds a feature | |
| # test: Adding missing tests or correcting existing tests | |
| types: | | |
| fix | |
| feat | |
| docs | |
| style | |
| refactor | |
| perf | |
| test | |
| build | |
| ci | |
| chore | |
| revert | |
| requireScope: false | |
| subjectPattern: ^[A-Z].+$ | |
| subjectPatternError: | | |
| The subject "{subject}" found in the pull request title "{title}" | |
| didn't match the configured pattern. Please ensure that the subject | |
| starts with an uppercase character. See .github/workflows/pr-title.yaml | |
| These conventional commits can then be used to automatically generate the CHANGELOG.md | |
| wip: true | |
| validateSingleCommit: true | |
| validateSingleCommitMatchesPrTitle: true |