This repository has been archived by the owner on Aug 14, 2024. It is now read-only.
docs: adds some early platform decision documents #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
| name: "Lint PR" | |
| on: | |
| pull_request_target: | |
| types: | |
| - opened | |
| - edited | |
| - synchronize | |
| permissions: | |
| pull-requests: read | |
| jobs: | |
| main: | |
| name: Validate PR title | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: amannn/action-semantic-pull-request@v5 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| # Configure which types are allowed (newline-delimited). | |
| # Default: https://github.com/commitizen/conventional-commit-types | |
| types: | | |
| fix | |
| feat | |
| docs | |
| style | |
| refactor | |
| pref | |
| test | |
| build | |
| ci | |
| chore | |
| revert | |
| # Configure which scopes are allowed (newline-delimited). | |
| # These are regex patterns auto-wrapped in `^ $`. | |
| # scopes: | | |
| # core | |
| # ui | |
| # JIRA-\d+ | |
| # Configure that a scope must always be provided. | |
| # requireScope: false | |
| # Configure which scopes are disallowed in PR titles (newline-delimited). | |
| # For instance by setting the value below, `chore(release): ...` (lowercase) | |
| # and `ci(e2e,release): ...` (unknown scope) will be rejected. | |
| # These are regex patterns auto-wrapped in `^ $`. | |
| # disallowScopes: | | |
| # release | |
| # [A-Z]+ | |
| # Configure additional validation for the subject based on a regex. | |
| # This example ensures the subject doesn't start with an uppercase character. | |
| subjectPattern: ^(?![A-Z]).+$ | |
| # If `subjectPattern` is configured, you can use this property to override | |
| # the default error message that is shown when the pattern doesn't match. | |
| # The variables `subject` and `title` can be used within the message. | |
| subjectPatternError: | | |
| The subject "{subject}" found in the pull request title "{title}" | |
| didn't match the configured pattern. Please ensure that the subject | |
| doesn't start with an uppercase character. | |
| # If you use GitHub Enterprise, you can set this to the URL of your server | |
| #githubBaseUrl: https://github.myorg.com/api/v3 | |
| # If the PR contains one of these newline-delimited labels, the | |
| # validation is skipped. 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 | |
| # If you're using a format for the PR title that differs from the traditional Conventional | |
| # Commits spec, you can use these options to customize the parsing of the type, scope and | |
| # subject. The `headerPattern` should contain a regex where the capturing groups in parentheses | |
| # correspond to the parts listed in `headerPatternCorrespondence`. | |
| # See: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#headerpattern | |
| #headerPattern: '^(\w*)(?:\(([\w$.\-*/ ]*)\))?: (.*)$' | |
| #headerPatternCorrespondence: type, scope, subject |