Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: commitMessageLowerCase #20930

Merged
merged 12 commits into from May 13, 2023
Merged

feat: commitMessageLowerCase #20930

merged 12 commits into from May 13, 2023

Conversation

kingcrunch
Copy link
Contributor

@kingcrunch kingcrunch commented Mar 14, 2023

Semantic-commits states, that only the first letter should be lowercased

Changes

Change the commit title formatting from "all lowercase" to "first letter lowercase" for semantic-commits.

Context

Semantic commits states, that only the first letter of the commit message should be lowercase. However, although this is not part of this change, there may be cases, where one needs to ignore this rule, for example if one needs to add JIRA-IDs to the commit title, which are traditionally all uppercase (sigh).

This is a follow-up of the discussion #20923

See also

It does (intentionally) not touch the PR title

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

Semantic-commits states, that only the first letter should be lowercased
@kingcrunch
Copy link
Contributor Author

To be honest: Just a wild guess, because not my language (and so on). I am open for recommendations, suggestions, whatever.

Copy link
Member

@viceice viceice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doesn't work as expected, it would only lowercase the first char of the semantic commit type

@HonkingGoose HonkingGoose added the breaking Breaking change, requires major version bump label Mar 18, 2023
@HonkingGoose
Copy link
Collaborator

HonkingGoose commented Mar 18, 2023

I'm labeling this PR breaking because of this quote from @rarkins: 1

Let's say we remove all commit message lower casing, probably in a major release to flag it's a breaking change.

Edit: the PR title is not breaking yet, so before merging one of the maintainers should add the ! in the correct place, so our Semantic Release bot creates a new major version.

Footnotes

  1. https://github.com/renovatebot/renovate/discussions/20931#discussioncomment-5351645

@rarkins
Copy link
Collaborator

rarkins commented Mar 18, 2023

Let's refer back to the discussion until consensus is reached

@rarkins rarkins closed this Mar 18, 2023
BREAKING CHANGE: Before this change, the titles where all-lowercase when using
`semanticCommits` (and kept as they were when not). After this change this
must be explicitly set.
according requirements, which suggests multiple options
- auto
- never
- first (future)
@rarkins rarkins reopened this Mar 21, 2023
@kingcrunch
Copy link
Contributor Author

build / test and build / lint fail, but the issues seems to be unrelated to this PR.

@kingcrunch
Copy link
Contributor Author

doesn't work as expected, it would only lowercase the first char of the semantic commit type

@viceice It's replaced now.

@rarkins rarkins changed the title fix: Do not lowercase entire commit title feat: commitMessageLowerCase Mar 21, 2023
@kingcrunch kingcrunch requested review from viceice and removed request for JamieMagee March 21, 2023 14:27
@kingcrunch
Copy link
Contributor Author

build / test and build / lint fail, but the issues seems to be unrelated to this PR.

It was related. Fixed :)

lib/config/options/index.ts Show resolved Hide resolved
lib/config/types.ts Outdated Show resolved Hide resolved
lib/modules/platform/azure/index.ts Outdated Show resolved Hide resolved
lib/modules/platform/bitbucket-server/index.ts Outdated Show resolved Hide resolved
lib/modules/platform/azure/index.ts Outdated Show resolved Hide resolved
lib/workers/repository/updates/generate.ts Outdated Show resolved Hide resolved
@kingcrunch kingcrunch requested a review from viceice March 21, 2023 19:47
@kingcrunch
Copy link
Contributor Author

The breaking flag can be remove, no?

@HonkingGoose
Copy link
Collaborator

@rarkins is the current PR still breaking? Please keep/remove the breaking label as needed. 😉

@viceice viceice mentioned this pull request Mar 24, 2023
28 tasks
lib/config/types.ts Show resolved Hide resolved
lib/workers/repository/updates/generate.ts Outdated Show resolved Hide resolved
lib/workers/repository/updates/generate.ts Outdated Show resolved Hide resolved
@kingcrunch
Copy link
Contributor Author

Is there is really no interest in fixing this bug?

Btw the PR is still no breaking change. It was, but I changed it.

So I don't know, why this is still postponed to the next major release.

At the end for me it was much easier to change the company rules, than fixing a bug here...

@viceice viceice requested a review from rarkins April 16, 2023 18:23
@rarkins rarkins removed the breaking Breaking change, requires major version bump label Apr 17, 2023
@rarkins
Copy link
Collaborator

rarkins commented Apr 17, 2023

There are currently code changes requested

@kingcrunch
Copy link
Contributor Author

Hi @rarkins

Maybe there is a misunderstanding, but I cannot see any request for change. I can see two question. One for you

@rarkins should we negate to be more save against missing value?
https://github.com/renovatebot/renovate/pull/20930/files#r1154877720

and one for @JamieMagee

@JamieMagee should we add undefined for typescript?
https://github.com/renovatebot/renovate/pull/20930/files#r1154874172

So this seems to be still under discussion and it doesn't make sense for me to propose changes, that are still discussed.

I don't know your workflows, but to me it seems nobody cares...

lib/modules/platform/azure/index.ts Outdated Show resolved Hide resolved
lib/workers/repository/updates/generate.ts Outdated Show resolved Hide resolved
@rarkins
Copy link
Collaborator

rarkins commented Apr 21, 2023

Please check for the currently 2 unresolved comments in https://github.com/renovatebot/renovate/pull/20930/files

Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
docs/usage/configuration-options.md Outdated Show resolved Hide resolved
@rarkins rarkins requested a review from viceice April 27, 2023 07:53
rarkins
rarkins previously approved these changes Apr 27, 2023
Copy link
Member

@viceice viceice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

markdown config needs sorted, otherwise LGTM

Copy link
Member

@viceice viceice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

markdown config needs sorted, otherwise LGTM

@rarkins rarkins enabled auto-merge May 12, 2023 08:12
@rarkins rarkins requested a review from viceice May 12, 2023 08:12
@rarkins rarkins added this pull request to the merge queue May 13, 2023
Merged via the queue into renovatebot:main with commit fc73b07 May 13, 2023
11 checks passed
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 35.82.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

mjunker pushed a commit to mjunker/renovate that referenced this pull request May 17, 2023
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
Co-authored-by: Rhys Arkins <rhys@arkins.net>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants