docs(release): document __INVALID__ conventional commit type #30124
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
View your CI Pipeline Execution ↗ for commit dea08e3.
☁️ Nx Cloud last updated this comment at |
llwt
force-pushed
the
document-invalid-commit-pattern
branch
2 times, most recently
from
84ac3ed to
a98518e
Compare
docs/shared/recipes/nx-release/customize-conventional-commit-types.md
Outdated
Show resolved
Hide resolved
|
|
||
| ## Including Invalid Commits in the Changelog | ||
|
|
||
| Nx only includes commits in the changelog that match either the [default conventional commit types](https://github.com/nrwl/nx/blob/master/packages/nx/src/command-line/release/config/conventional-commits.ts) or types you've [added to your configuration](#defining-non-standard-commit-types). |
There was a problem hiding this comment.
Let's not link to the codebase, let's link to the specification to show what valid conventional commits are.
There was a problem hiding this comment.
The spec doesn't state what is valid, outside of fix and feat, unless I'm missing something.
I wanted to link out to the types we define by default for Conventional Commits, but Conventional Commits doesn't dictate a standard. My next thought was to link to packages/nx/src/command-line/release/config/conventional-commits.ts, but I'm not sure if that's a typical thing we do. (also worried about links breaking in the future)
Are you referring to the Angular Convention?
There was a problem hiding this comment.
This section is specifically about invalid commits - commits that do not match the specification and would ordinarily be ineligible for this feature.
It's not about custom commit types like the rest of the document is, where the commit follows the specification in terms of commit structure, but is using custom types.
E.g.
Valid conventional commit with custom type (not relevant to this section):
mycustomtype(optional-scope): a commit message
Invalid convetional commit:
I made a change.
This section is about the latter. Only commits like that will hit the special __INVALID__ type (that is naturally skipped/does nothing by default)
There was a problem hiding this comment.
Ahh right, that makes sense. I'll update accordingly.
docs/shared/recipes/nx-release/customize-conventional-commit-types.md
Outdated
Show resolved
Hide resolved
llwt
force-pushed
the
document-invalid-commit-pattern
branch
from
592ec5a to
3be3301
Compare
docs/shared/recipes/nx-release/customize-conventional-commit-types.md
Outdated
Show resolved
Hide resolved
Co-authored-by: James Henry <james@henry.sc>
llwt
force-pushed
the
document-invalid-commit-pattern
branch
from
a723f90 to
dea08e3
Compare
|
This final form is great, thank you! |
Document changes added in #29658