Commit c4b6330
authored
ci: Enforce conventional commit structure for commit messages #1 (cadence-workflow#7278)
<!-- Tell your future self why have you made these changes -->
**Why?**
Our existing commit process:
- doesn't immediately convey when there are breaking changes to the
releaser
- doesn't provide information about how to categorize changes in each
release
- is entirely manual preparing releases
- doesn't always give "good" information about what is contained within
a commit
- doesn't give a good idea of the risk of a given commit
Furthermore, users have stated that our release notes do not provide
easily discernable information about what is in a release, including:
- if there are breaking changes
- which features are in a given release
- why they should upgrade
Adding conventional commits aims to tackle these pieces and make
contributing to the repository significantly easier.
This PR adds a linter that will give feedback to developers on their
commit message style, and will eventually enforce conventional commits
for each merge PR.
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
**How did you test it?**
Currently testing.
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
**Potential risks**
Adding this GitHub action may have unintended consequences for the
commit process, and should be monitored to ensure that it doesn't
inhibit merging to the repository.
<!-- Is it notable for release? e.g. schema updates, configuration or
data migration required? If so, please mention it, and also update
CHANGELOG.md -->
**Release notes**
N/A
<!-- Is there any documentation updates should be made for config,
https://cadenceworkflow.io/docs/operation-guide/setup/ ? If so, please
open an PR in https://github.com/cadence-workflow/cadence-docs -->
**Documentation Changes**
1 parent e446b5c commit c4b6330
1 file changed
+72
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
0 commit comments