Skip to content

Commit 301cd7b

Browse files
committed
feat: introduce commit-it library for (Conventional) Commit management
1 parent a6003f2 commit 301cd7b

15 files changed

+2336
-5710
lines changed

docs/github-action.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,27 @@ jobs:
8585
include-commits: false # OPTIONAL; enforces the exclusion of commits associated with your Pull Request
8686
```
8787
88-
In addition, above example has disabled pull request label management, just to show
88+
In addition, above example has disabled pull request label management.
89+
90+
### Limiting Conventional Commit Type and/or Scope
91+
92+
You can limit the Conventional Commit Type and/or Scope using the related input parameters:
93+
94+
```yaml
95+
- uses: dev-build-deploy/commit-me@v0
96+
with:
97+
# OPTIONAL; Enforce that each commit contains a predefined scope
98+
scope: |
99+
backend
100+
frontend
101+
# OPTIONAL; Limit the Conventional Commits type to `feat`, `fix`, `docs` and a custom entry `debt`
102+
types: |
103+
feat
104+
fix
105+
docs
106+
debt
107+
```
108+
89109
90110
### Event triggers & activities
91111
@@ -107,6 +127,7 @@ In addition, we recommend the following activity types:
107127
| `token` | *NO* | GitHub token needed to access your commits in your pull request. This is **only** required in case you want to:<br><ul><li>Validate commits associated with your Pull Request</li><li>Update labels in your Pull Request</li></ul> |
108128
| `update-labels` | *NO* | Allow CommitMe to manage [labels](#pull-request-labels) based on the [Conventional Commits] metadata (requires `pull-requests:write` permission), defaults to `true` |
109129
| `include-commits` | *NO* | Include commits associated with the Pull Request; by default we use the repository configuration settings to determine this value (requires `contents:write` permission if **NOT** set). |
130+
|
110131

111132
### Permissions
112133

docs/specifications.md

-30
This file was deleted.

0 commit comments

Comments
 (0)