mirror of
https://github.com/tofuutils/pre-commit-opentofu.git
synced 2025-10-15 17:38:54 +02:00
chore: Validate PR title (#297)
This commit is contained in:
parent
e1bccb7585
commit
8c063c7824
3 changed files with 74 additions and 1 deletions
17
.github/semantic.yml
vendored
Normal file
17
.github/semantic.yml
vendored
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# Disable validation, and skip status check creation
|
||||
enabled: true
|
||||
# Always validate the PR title, and ignore the commits
|
||||
titleOnly: true
|
||||
# Always validate all commits, and ignore the PR title
|
||||
commitsOnly: false
|
||||
# Always validate the PR title AND all the commits
|
||||
titleAndCommits: false
|
||||
# By default types specified in commitizen/conventional-commit-types is used.
|
||||
# See: https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json
|
||||
# You can override the valid types
|
||||
types:
|
||||
- feat
|
||||
- fix
|
||||
- docs
|
||||
- ci
|
||||
- chore
|
||||
56
.github/workflows/pr-title.yml
vendored
Normal file
56
.github/workflows/pr-title.yml
vendored
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
name: "Validate PR title"
|
||||
|
||||
on:
|
||||
pull_request_target:
|
||||
types:
|
||||
- opened
|
||||
- edited
|
||||
- synchronize
|
||||
|
||||
jobs:
|
||||
main:
|
||||
name: Validate PR title
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
# Please look up the latest version from
|
||||
# https://github.com/amannn/action-semantic-pull-request/releases
|
||||
- uses: amannn/action-semantic-pull-request@v3.4.6
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
# Configure which types are allowed.
|
||||
# Default: https://github.com/commitizen/conventional-commit-types
|
||||
types: |
|
||||
fix
|
||||
feat
|
||||
docs
|
||||
ci
|
||||
chore
|
||||
# Configure which scopes are allowed.
|
||||
scopes: |
|
||||
core
|
||||
ui
|
||||
# Configure that a scope must always be provided.
|
||||
requireScope: false
|
||||
# Configure additional validation for the subject based on a regex.
|
||||
# This example ensures the subject starts 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
|
||||
starts with an uppercase character.
|
||||
# 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
|
||||
# When using "Squash and merge" on a PR with only one commit, GitHub
|
||||
# will suggest using that commit message instead of the PR title for the
|
||||
# merge commit, and it's easy to commit this by mistake. Enable this option
|
||||
# to also validate the commit message for one commit PRs.
|
||||
validateSingleCommit: true
|
||||
2
.github/workflows/release.yml
vendored
2
.github/workflows/release.yml
vendored
|
|
@ -29,4 +29,4 @@ jobs:
|
|||
@semantic-release/changelog@6.0.0
|
||||
@semantic-release/git@10.0.0
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.SEMANTIC_RELEASE_TOKEN }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue