Skip to content

Commit ae76679

Browse files
committed
docs: add the example for prefix based parsing for scopes
1 parent 3ffc2e2 commit ae76679

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ feat(client): add component
1717

1818
The action can be used with both the `pull_request` and `pull_request_target` trigger.
1919

20-
`default`
20+
### Default
2121

2222
```yaml
2323
name: validate-pull-request-title
@@ -41,7 +41,7 @@ jobs:
4141
uses: kontrolplane/pull-request-title-validator@v1.2.0
4242
```
4343
44-
`custom types`
44+
### Custom types
4545
4646
```yaml
4747
name: validate-pull-request-title
@@ -67,7 +67,9 @@ jobs:
6767
types: "fix,feat,chore"
6868
```
6969
70-
`custom scopes`
70+
### Custom scopes
71+
72+
Scopes support regular expression patterns, allowing you to define specific patterns to match the scopes you want to allow. You can also separate multiple scopes using commas.
7173
7274
```yaml
7375
name: validate-pull-request-title
@@ -88,7 +90,7 @@ jobs:
8890
runs-on: ubuntu-latest
8991
steps:
9092
- name: validate pull request title
91-
uses: kontrolplane/pull-request-title-validator@v1.2.0
93+
uses: kontrolplane/pull-request-title-validator@v1.4.0
9294
with:
93-
scopes: "api,lang,parser"
95+
scopes: "api,lang,parser,package/.+"
9496
```

0 commit comments

Comments
 (0)