|
| 1 | +# Changelog |
| 2 | + |
| 3 | +## 2023-12-24 |
| 4 | + |
| 5 | +- always require a valid type (do not allow this anymore: 'myscope: my message' or ': myscope: test' |
| 6 | + - https://www.conventionalcommits.org/en/v1.0.0/#specification (1) |
| 7 | + |
| 8 | +- add all valid semantic versioning types (build, ci, revert) |
| 9 | + - https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/config-conventional/index.js#L22 |
| 10 | + |
| 11 | +- allow more characters in the scope (example: 'feat(my-scope, other-scope): my message') |
| 12 | + - https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/rules/src/scope-enum.test.ts#L11 |
| 13 | + |
| 14 | +- allow optional exclamation mark before the colon to indicate a breaking change (example: 'feat(api)!: changed endpoint for travel times') |
| 15 | + - https://www.conventionalcommits.org/en/v1.0.0/#commit-message-with-scope-and--to-draw-attention-to-breaking-change |
| 16 | + |
| 17 | +- tested the regex on https://regex101.com with these values: |
| 18 | + |
| 19 | +``` |
| 20 | +===== Valid commit messages: ===== |
| 21 | +build: my message |
| 22 | +chore: my message |
| 23 | +ci: my message |
| 24 | +docs: my message |
| 25 | +feat: my message |
| 26 | +fix: my message |
| 27 | +perf: my message |
| 28 | +refactor: my message |
| 29 | +revert: my message |
| 30 | +style: my message |
| 31 | +test: my message |
| 32 | +build(my-scope): my message |
| 33 | +chore(my-scope): my message |
| 34 | +ci(my-scope): my message |
| 35 | +docs(my-scope): my message |
| 36 | +feat(my-scope): my message |
| 37 | +fix(my-scope): my message |
| 38 | +perf(my-scope): my message |
| 39 | +refactor(my-scope): my message |
| 40 | +revert(my-scope): my message |
| 41 | +style(my-scope): my message |
| 42 | +test(my-scope): my message |
| 43 | +feat(my-scope, other-scope): my message |
| 44 | +feat(my_scope): my message |
| 45 | +feat(my_scope): MY MESSAGE |
| 46 | +feat(my_scope)!: MY MESSAGE |
| 47 | +
|
| 48 | +===== Valid commit message examples from https://www.conventionalcommits.org/en/v1.0.0/#examples: ===== |
| 49 | +feat: allow provided config object to extend other configs |
| 50 | +feat!: send an email to the customer when a product is shipped |
| 51 | +feat(api)!: send an email to the customer when a product is shipped |
| 52 | +chore!: drop support for Node 6 |
| 53 | +docs: correct spelling of CHANGELOG |
| 54 | +feat(lang): add Polish language |
| 55 | +fix: prevent racing of requests |
| 56 | +revert: let us never again speak of the noodle incident |
| 57 | +
|
| 58 | +===== Invalid commit messages: ===== |
| 59 | +feat:my message (no space after the colon) |
| 60 | +feat : my message (additional space not allowed) |
| 61 | + feat: my message (starting space not allowed) |
| 62 | +feat!(scope): my message (exclamation mark for blocking change should be right behind the colon) |
| 63 | +feat(!scope): my message (exclamation mark for blocking change should be right behind the colon) |
| 64 | +feat(scope!): my message (exclamation mark for blocking change should be right behind the colon) |
| 65 | +feat(scope):! my message (exclamation mark for blocking change should be right behind the colon) |
| 66 | +: myscope my message (no type) |
| 67 | +: myscope::: my message (no type) |
| 68 | +: my message (no type) |
| 69 | +myscope: my message (invalid type) |
| 70 | +myscope: my message (invalid type) |
| 71 | +FEAT(my-scope): my message (only lowercase allowed for type) |
| 72 | +feat(MY-SCOPE): my message (only lowercase allowed for scope) |
| 73 | +``` |
| 74 | + |
| 75 | +## 2023-05-01 |
| 76 | + |
| 77 | +- fix: Fix vs code merges |
| 78 | + |
| 79 | +## 2019-05-27 |
| 80 | + |
| 81 | +- updated regex |
| 82 | + |
| 83 | +## 2019-05-20 |
| 84 | + |
| 85 | +- initial |
0 commit comments