Feat: Clean up public API and improve docs #217
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: "Verify Semantic PR Title" | |
| on: | |
| pull_request_target: | |
| types: | |
| - opened | |
| - edited | |
| - synchronize | |
| permissions: | |
| pull-requests: read | |
| jobs: | |
| validate_pr_title: | |
| 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). | |
| # See: https://github.com/commitizen/conventional-commit-types/blob/master/index.json | |
| types: | | |
| Fix | |
| Feat | |
| Docs | |
| CI | |
| Chore | |
| Build | |
| Test | |
| # # We don't use scopes as of now | |
| # scopes: | | |
| # core | |
| # ui | |
| # JIRA-\d+ | |
| # Require capitalization for the first letter of the subject. | |
| subjectPattern: ^[A-Z].*$ | |
| # 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 | |
| start with an uppercase character. |