File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 2929 - name : Check Commit Format
3030 uses : gsactions/commit-message-checker@v2
3131 with :
32- pattern : ' ^(fix|feat|docs|style|refactor|test|chore){1}(\([\w\-\.]+\))?( !)?: .+( (#\d+))? $'
33- error : ' Your commit message should be in the format "type: Description (#issue) ". Example: "fix: Update build (#33) "'
32+ pattern : ' ^(EPMDEDP-\d+: ( fix|feat|docs|style|refactor|test|chore)( !)?: .+|(chore|build)\(deps\): Bump .+) $'
33+ error : ' Your commit message should be in the format "EPMDEDP-ID: type: Description". Example: "EPMDEDP-16058: feat: add feature "'
3434 excludeDescription : ' true'
3535 excludeTitle : ' true'
3636 checkAllCommitMessages : ' true'
@@ -39,10 +39,10 @@ jobs:
3939 - name : Check Line Length
4040 uses : gsactions/commit-message-checker@v2
4141 with :
42- pattern : ' .{0,50} '
43- error : ' The maximum line length of 50 characters is exceeded.'
42+ pattern : ' ^.{10,72}$ '
43+ error : ' The maximum line length of 72 characters is exceeded.'
4444 excludeDescription : ' true'
45- excludeTitle : ' true '
45+ excludeTitle : ' false '
4646 checkAllCommitMessages : ' true'
4747 accessToken : ${{ secrets.GITHUB_TOKEN }}
4848
Original file line number Diff line number Diff line change @@ -95,6 +95,30 @@ While the prerequisites above must be satisfied prior to having your pull reques
9595
9696### Git Commit Messages
9797
98+ Commit messages ** must** follow the platform format for Jira traceability and changelog generation:
99+
100+ ** Format:** ` EPMDEDP-<ID>: <type>: <description> `
101+
102+ ** Example:** ` EPMDEDP-16058: feat: add feature `
103+
104+ ** Allowed types:**
105+
106+ | Type | Purpose |
107+ | ----------| ----------------------------|
108+ | feat | New feature |
109+ | fix | Bug fix |
110+ | docs | Documentation changes |
111+ | style | Code style/formatting |
112+ | refactor | Code refactoring |
113+ | test | Adding/updating tests |
114+ | chore | Maintenance tasks |
115+
116+ Use the ` ! ` suffix after the type for breaking changes (e.g. ` feat!: change API ` ).
117+
118+ ** Additional guidelines:**
119+
120+ Automated dependency update commits are also allowed in the format ` chore(deps): Bump <dependency> ... ` .
121+
98122* Use the present tense ("Add feature" not "Added feature")
99123* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
100124* Limit the first line to 72 characters or less
You can’t perform that action at this time.
0 commit comments