Commit messages should not be fully lowercased #12062

jonahsnider · 2021-10-07T11:46:48Z

How are you running Renovate?

WhiteSource Renovate hosted app on github.com

Please select which platform you are using if self-hosting.

No response

If you're self-hosting Renovate, tell us what version of Renovate you run.

No response

Describe the bug

When Renovate opens a PR with semantic commits the entire commit message/PR title is lowercased. This is unnecessary, only the first letter needs to be lowercased (per Angular commit guidelines, I think most other semantic commit specs do the same).

Given the title:

fix(deps): Update My Org dependencies

Actual behavior:

fix(deps): update my org dependencies

Expected:

fix(deps): update My Org dependencies

Relevant code:

renovate/lib/workers/repository/updates/generate.ts

Lines 184 to 189 in 00e1917

    
           if (upgrade.toLowerCase) { 
        
             // We only need to lowercase the first line 
        
             const splitMessage = upgrade.commitMessage.split('\n'); 
        
             splitMessage[0] = splitMessage[0].toLowerCase(); 
        
             upgrade.commitMessage = splitMessage.join('\n'); 
        
           }

Relevant debug logs

No response

Have you created a minimal reproduction repository?

No reproduction repository

The text was updated successfully, but these errors were encountered:

rarkins · 2021-10-07T12:02:37Z

What specific text in the linked angular document are you referring to?

jonahsnider · 2021-10-07T14:20:33Z

<type>(<scope>): <short summary>
[...]

Use the summary field to provide a succinct description of the change:

[...]

don't capitalize the first letter

From "Commit Message Format" > "Commit Message Header" > "Summary"

rarkins · 2021-10-07T15:20:19Z

We need to make sure our findPr function is case insensitive before we make this change.

RahulGautamSingh · 2021-10-18T04:53:10Z

I have already worked on the specified file and function while fixing #12025 , I can update this function and close this issue with #12025. I would like work on this while awaiting feedback on my other PRs.

Xavientois · 2021-10-20T17:23:29Z

@RahulGautamSingh I see that #12025 is now merged. Were you able to fix this as part of that pull request?

RahulGautamSingh · 2021-10-22T09:15:15Z

@Xavientois I am sorry for the delay. There is one folder lib/workers remaining to be merged, cause I haven't created a PR for it yet. I have completed the work but there has been a blackout in my city for last 3 days due to a rainstorm, so I haven't been able to use my laptop.

The work is completed just the commit & push is remaining.

Also it seems I linked the wrong PR, I meant that this issue will be closed with #11875 .

RahulGautamSingh · 2021-10-24T13:30:51Z

We need to make sure our findPr function is case insensitive before we make this change.

export async function findPr({
  branchName,
  prTitle,
  state = PrState.All,
}: FindPRConfig): Promise<Pr | null> {
  let prsFiltered: Pr[] = [];
  try {
    const prs = await getPrList();

    prsFiltered = prs.filter(
      (item) => item.sourceRefName === getNewBranchName(branchName)
    );

    if (prTitle) {
      prsFiltered = prsFiltered.filter((item) => item.title === prTitle);
    }

    switch (state) {
      case PrState.All:
        // no more filter needed, we can go further...
        break;
      case PrState.NotOpen:
        prsFiltered = prsFiltered.filter((item) => item.state !== PrState.Open);
        break;
      default:
        prsFiltered = prsFiltered.filter((item) => item.state === state);
        break;
    }
  } catch (err) {
    logger.error({ err }, 'findPr error');
  }
  if (prsFiltered.length === 0) {
    return null;
  }
  return prsFiltered[0];
}

findPr function seems to be case insensitive.
Can I make changes to the code snippet highlighted by @jonahsnider?

rarkins · 2021-10-24T14:16:18Z

Isn't item.title === prTitle a case sensitive check?

RahulGautamSingh · 2021-10-24T14:47:36Z

Isn't item.title === prTitle a case sensitive check?

My bad. I guess we have to use localCompare() instead.

rarkins · 2021-10-24T15:21:01Z

Or a couple of couple of toLowerCase()

RahulGautamSingh · 2021-10-26T16:26:30Z

renovate/lib/workers/repository/updates/generate.ts

Lines 197 to 210 in a13da7e

    
           if (upgrade.prTitle) { 
        
             upgrade.prTitle = template.compile(upgrade.prTitle, upgrade); 
        
             upgrade.prTitle = template.compile(upgrade.prTitle, upgrade); 
        
             upgrade.prTitle = template 
        
               .compile(upgrade.prTitle, upgrade) 
        
               .trim() 
        
               .replace(/\s+/g, ' '); 
        
             // istanbul ignore if 
        
             if (upgrade.prTitle !== sanitize(upgrade.prTitle)) { 
        
               throw new Error(CONFIG_SECRETS_EXPOSED); 
        
             } 
        
             if (upgrade.toLowerCase) { 
        
               upgrade.prTitle = upgrade.prTitle.toLowerCase(); 
        
             }

Do we need to change this too?

rarkins · 2021-10-26T17:35:05Z

Depends where/why the lower case field is set.

RahulGautamSingh · 2021-10-29T04:49:40Z

Depends where/why the lower case field is set.

I think we might have change the
upgrade.prTitle = upgrade.prTitle.toLowerCase();
cause the toLowerCase field of upgrade will be true in case a commit follows all rules.

renovate/lib/workers/repository/updates/generate.ts

Lines 163 to 166 in 5a33033

    
             upgrade.toLowerCase = 
        
               regEx(/[A-Z]/).exec(upgrade.semanticCommitType) === null && // TODO #12071 
        
               !upgrade.semanticCommitType.startsWith(':'); 
        
           }

rarkins · 2021-10-29T05:14:24Z

So we need to get smarter than simply lower or not lower case

RahulGautamSingh · 2021-10-30T11:21:15Z

@rarkins

 if (upgrade.toLowerCase) {
        const titleMessage = upgrade.prTitle.split(' ');
        titleMessage[0] = titleMessage[0].toLowerCase();
        upgrade.prTitle = titleMessage.join(' ');
        upgrade.prTitle = upgrade.prTitle.toLowerCase();
      }
    } else {
      [upgrade.prTitle] = upgrade.commitMessage.split('\n');
    }

===

 if (upgrade.toLowerCase) {
      // We only need to lowercase the first line
      const splitMessage = upgrade.commitMessage.split('\n');
      let firstMessage: string[];
      if (splitMessage.includes(':')) {
        firstMessage = splitMessage[0].split(':')[1].split(' ');
      } else {
        firstMessage = splitMessage[0].split(' ');
      }
      firstMessage[0] = firstMessage[0].toLowerCase();
      splitMessage[0] = firstMessage.join(' ');
      splitMessage[0] = splitMessage[0].toLowerCase();
      upgrade.commitMessage = splitMessage.join('\n');
    }

These are the changes I came up with. I am trying on a regex solution but the regex becomes to complex and uses lookarounds in it, which RE2 doesn't support.

I ran into one problem while running build workflow on the updated files.

Jest: "global" coverage threshold for statements (100%) not met: 99.98%
Jest: "global" coverage threshold for lines (100%) not met: 99.98%

I tried looking into it last time but couldn't find a solution, could you please help me with solving this one?

The errors occur when I use the new code, coverage is 100% incase of old code.

rarkins · 2021-10-31T05:18:41Z

Is the only reason we do lower casing for semantic commits?

RahulGautamSingh · 2021-10-31T06:02:40Z

Is the only reason we do lower casing for semantic commits?

It seems so. To get more details we will have test it by opening a PR and then the check details in CodeCov site.
I am not familiar with coverage so I cannot be sure.

rarkins · 2021-10-31T06:15:42Z

It looks like upgrade.toLowerCase is only set due to semantic commits. So we should rename it to be e.g. upgrade.semanticCommitCasing and afterwards do a more intelligent lower-casing (of only the first letter, not all)

RahulGautamSingh · 2021-11-01T11:41:07Z

It looks like upgrade.toLowerCase is only set due to semantic commits. So we should rename it to be e.g. upgrade.semanticCommitCasing and afterwards do a more intelligent lower-casing (of only the first letter, not all)

New code:-

 if (upgrade.semanticCommitCasing) {
      // We only need to lowercase the first word
      const splitMessage = upgrade.commitMessage.split('\n');
      splitMessage[0] = splitMessage[0].replace(
        splitMessage[0].includes(':') ? regEx(/: \w+/) : regEx(/^\w+/),
        (match) => match.toLowerCase()
      );
      upgrade.commitMessage = splitMessage.join('\n');
    }

 if (upgrade.semanticCommitCasing) {
        upgrade.prTitle = upgrade.prTitle.replace(regEx(/^\w+/), (match) =>
          match.toLowerCase()
        );
      }

RahulGautamSingh · 2021-11-11T04:00:22Z

Hey @rarkins , do you approve of this suggestion by @pret-a-porter ?

kingcrunch · 2023-03-14T15:26:02Z

Hi,

We really need this feature. So if somebody can have a look at his, we would really appreciate it. I for myself will try, but don't expect too much, because I am more a Go/Rust guy ^^

viceice · 2023-03-14T18:20:54Z

we should review @pret-a-porter PR again, which then needs a lot real tests to not break things again.

The Angular reference for the summary [1] demands "don't capitalize the first letter" and Renovate adheres to it (without making it configurable yet [2]), so only warn here in order to accept Renovate PRs. [1]: https://github.com/angular/angular/blob/main/CONTRIBUTING.md#summary [2]: renovatebot/renovate#12062 Signed-off-by: Sebastian Schuberth <[email protected]>

github-actions · 2023-04-21T07:27:46Z

Hi there,

Get your issue fixed faster by creating a minimal reproduction. This means a repository dedicated to reproducing this issue with the minimal dependencies and config possible.

Before we start working on your issue we need to know exactly what's causing the current behavior. A minimal reproduction helps us with this.

To get started, please read our guide on creating a minimal reproduction.

We may close the issue if you, or someone else, haven't created a minimal reproduction within two weeks. If you need more time, or are stuck, please ask for help or more time in a comment.

Good luck,

The Renovate team

Xavientois · 2023-04-21T14:07:56Z

@rarkins If this PR to fix the issue is soon to be merged, do we still need to provide a minimal reproduction?

github-actions · 2023-05-10T01:53:40Z

When a bug has been marked as needing a reproduction, it means nobody can work on it until one is provided. In cases where no reproduction is possible, or the issue creator does not have the time to reproduce, we unfortunately need to close such issues as they are non-actionable and serve no benefit by remaining open. This issue will be closed after 7 days of inactivity.

github-actions · 2023-05-17T01:57:03Z

This bug report has been closed as we need a reproduction to work on this. If the original poster or anybody else with the same problem discovers that they can reproduce it, please create a new issue, and reference this issue.

HonkingGoose · 2023-05-19T16:19:13Z

@rarkins If this PR to fix the issue is soon to be merged, do we still need to provide a minimal reproduction?

That PR is now merged:

feat: commitMessageLowerCase #20930

I don't know if we still need a reproduction for the original problem though? I'll let @rarkins decide. Maybe we can close this as "done" instead of "not planned". 😄

jonahsnider added priority-5-triage status:requirements Full requirements are not yet known, so implementation should not be started type:bug Bug fix of existing functionality labels Oct 7, 2021

rarkins assigned RahulGautamSingh Oct 18, 2021

RahulGautamSingh mentioned this issue Nov 2, 2021

fix: lowercase first word of commit message #12440

Closed

6 tasks

github-actions bot locked as resolved and limited conversation to collaborators Jul 27, 2022

rarkins reopened this Sep 8, 2022

rarkins added priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others and removed priority-4-low Low priority, unlikely to be done unless it becomes important to more people labels Sep 8, 2022

rarkins mentioned this issue Sep 8, 2022

Gradle: dependency versions via variables are always lower-case's #17703

Closed

pret-a-porter mentioned this issue Nov 21, 2022

fix: commit message #19013

Closed

6 tasks

scop mentioned this issue Dec 11, 2022

semantic commit scope and type should not be lowercased #16839

Closed

renovatebot unlocked this conversation Mar 14, 2023

rarkins unassigned pret-a-porter Mar 14, 2023

rarkins added help wanted Help is needed or welcomed on this issue status:ready and removed status:in-progress Someone is working on implementation labels Mar 14, 2023

kingcrunch mentioned this issue Mar 14, 2023

feat: commitMessageLowerCase #20930

Merged

6 tasks

viceice added the breaking Breaking change, requires major version bump label Mar 24, 2023

viceice mentioned this issue Mar 24, 2023

v36 planning #21134

Closed

28 tasks

rarkins added the auto:reproduction A minimal reproduction is necessary to proceed label Apr 21, 2023

rarkins added status:requirements Full requirements are not yet known, so implementation should not be started and removed status:ready labels Apr 21, 2023

github-actions bot added the stale label May 10, 2023

github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale May 17, 2023

HonkingGoose closed this as completed May 19, 2023

github-actions bot locked as resolved and limited conversation to collaborators Jun 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Commit messages should not be fully lowercased #12062

Commit messages should not be fully lowercased #12062

jonahsnider commented Oct 7, 2021

rarkins commented Oct 7, 2021

jonahsnider commented Oct 7, 2021

rarkins commented Oct 7, 2021

RahulGautamSingh commented Oct 18, 2021 •

edited

Loading

Xavientois commented Oct 20, 2021

RahulGautamSingh commented Oct 22, 2021 •

edited

Loading

RahulGautamSingh commented Oct 24, 2021 •

edited

Loading

rarkins commented Oct 24, 2021

RahulGautamSingh commented Oct 24, 2021 •

edited

Loading

rarkins commented Oct 24, 2021

RahulGautamSingh commented Oct 26, 2021 •

edited

Loading

rarkins commented Oct 26, 2021

RahulGautamSingh commented Oct 29, 2021 •

edited

Loading

rarkins commented Oct 29, 2021

RahulGautamSingh commented Oct 30, 2021 •

edited

Loading

rarkins commented Oct 31, 2021

RahulGautamSingh commented Oct 31, 2021

rarkins commented Oct 31, 2021

RahulGautamSingh commented Nov 1, 2021 •

edited

Loading

RahulGautamSingh commented Nov 11, 2021 •

edited

Loading

kingcrunch commented Mar 14, 2023

viceice commented Mar 14, 2023

github-actions bot commented Apr 21, 2023

Xavientois commented Apr 21, 2023 •

edited

Loading

github-actions bot commented May 10, 2023

github-actions bot commented May 17, 2023

HonkingGoose commented May 19, 2023

Commit messages should not be fully lowercased #12062

Commit messages should not be fully lowercased #12062

Comments

jonahsnider commented Oct 7, 2021

How are you running Renovate?

Please select which platform you are using if self-hosting.

If you're self-hosting Renovate, tell us what version of Renovate you run.

Describe the bug

Relevant debug logs

Have you created a minimal reproduction repository?

rarkins commented Oct 7, 2021

jonahsnider commented Oct 7, 2021

rarkins commented Oct 7, 2021

RahulGautamSingh commented Oct 18, 2021 • edited Loading

Xavientois commented Oct 20, 2021

RahulGautamSingh commented Oct 22, 2021 • edited Loading

RahulGautamSingh commented Oct 24, 2021 • edited Loading

rarkins commented Oct 24, 2021

RahulGautamSingh commented Oct 24, 2021 • edited Loading

rarkins commented Oct 24, 2021

RahulGautamSingh commented Oct 26, 2021 • edited Loading

rarkins commented Oct 26, 2021

RahulGautamSingh commented Oct 29, 2021 • edited Loading

rarkins commented Oct 29, 2021

RahulGautamSingh commented Oct 30, 2021 • edited Loading

rarkins commented Oct 31, 2021

RahulGautamSingh commented Oct 31, 2021

rarkins commented Oct 31, 2021

RahulGautamSingh commented Nov 1, 2021 • edited Loading

RahulGautamSingh commented Nov 11, 2021 • edited Loading

kingcrunch commented Mar 14, 2023

viceice commented Mar 14, 2023

github-actions bot commented Apr 21, 2023

Xavientois commented Apr 21, 2023 • edited Loading

github-actions bot commented May 10, 2023

github-actions bot commented May 17, 2023

HonkingGoose commented May 19, 2023

RahulGautamSingh commented Oct 18, 2021 •

edited

Loading

RahulGautamSingh commented Oct 22, 2021 •

edited

Loading

RahulGautamSingh commented Oct 24, 2021 •

edited

Loading

RahulGautamSingh commented Oct 24, 2021 •

edited

Loading

RahulGautamSingh commented Oct 26, 2021 •

edited

Loading

RahulGautamSingh commented Oct 29, 2021 •

edited

Loading

RahulGautamSingh commented Oct 30, 2021 •

edited

Loading

RahulGautamSingh commented Nov 1, 2021 •

edited

Loading

RahulGautamSingh commented Nov 11, 2021 •

edited

Loading

Xavientois commented Apr 21, 2023 •

edited

Loading