CONTRIBUTING.md: Describe commit keywords #12211
Conversation
| * for commits pushed to the default (`master`) branch, including merging a branch to the default branch: Although the touched packages will not be built, a new version of the correspoding JLL packages will be published, using as artifacts those from the latest registered versions of the packages. The build number will be increased by one. (This is only interesting for maintainers when merging a branch into the master branch; see section "Information for maintainers" below.) | ||
|
|
||
| `[skip ci]` has the following effect (this keyword is only interesting for maintainers when merging a branch into the master branch; see section "Information for maintainers" below): | ||
| * in pull requests, this has no effect. |
There was a problem hiding this comment.
I'm not entirely sure this is true: I've seen many cases where CI just doesn't run in pull requests, effectively making them unmergeable. The reason why this wasn't documented in this section is because users should just not use it.
There was a problem hiding this comment.
Even if normal users shouldn't use it, I think it is good to document it for maintainers, because I always seem to forget the difference between the two and where each one needs to go.
There was a problem hiding this comment.
Yes, but it's documented below.
There was a problem hiding this comment.
It's documented on a long page. That documentation begins with "`[skip ci] to not run CI at all [...]". That fooled me. (The sentence continues with a clause that explains that the "not at all" does not always apply.)
There is also a section titled "Special keywords in commit messages". It mentions only [skip build]. The other keyword, [skip ci], is only described further down.
I am updating this page because I find it confusing, and I regularly make mistakes using these keywords. Hence the two new subsections called "How to [...]".
3 participants
Clarify the description of the commit keywords.