Skip to content

Commit 0e36659

Browse files
authored
Apply suggestions from code review
1 parent 3a72226 commit 0e36659

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

docs/usage/release-notes-for-major-versions.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -50,25 +50,22 @@ If you want to allow squash merges on your GitHub repository, follow the steps i
5050
#### Branch names with multiple slashes
5151

5252
Branch names with multiple forward slashes (`/`) will change if `branchNameStrict=true`.
53-
54-
Suggest a "old behavior" example.
55-
56-
Suggest a "new behavior" example.
53+
Previously there were cases where special characters could still enter branch names despite `branchNameStrict=true` being set.
54+
This has now been corrected, which can result in some branch name changes because any forward slashes will be converted to hyphens.
5755

5856
### Commentary for 39
5957

6058
#### Technical reasons for trying the squash merge first on GitHub
6159

62-
Insert Renovate maintainer details here.
60+
Renovate has changed its GitHub merge preference to "squash" because this way results in signed commits, while "rebase" merges do not.
6361

6462
Read the [GitHub Docs, Signature verification for rebase and merge](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#signature-verification-for-rebase-and-merge) to learn more about commit signing.
6563

66-
Note from HonkingGoose to maintainers, the [GitHub Docs, signature verification for bots](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#signature-verification-for-bots) have more info about signing commits as bot author.
67-
I don't know if we already do this, or if the method is better than relying on a specific kind of merge type?
6864

6965
#### Why we change branch names with multiple slashes
7066

71-
Explain why this was changed here.
67+
Branches with slashes are undesirable and this was a bug.
68+
We are changing it in a major release out of politeness so that you know to expect some branch name changes if you have `branchNameStrict` enabled.
7269

7370
### Link to release notes for 39
7471

0 commit comments

Comments
 (0)