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

fix(config)!: Use depNameSanitized in branch name for vulnerability alerts #25166

Merged
merged 8 commits into from
Apr 14, 2024

Conversation

takac
Copy link
Contributor

@takac takac commented Oct 12, 2023

Changes

Use the santaised dep name for branch creation, this ensure that the branch does not have special characters which could cause issues with other services.

go-golang-org/x/net-vulnerability should be go-golang-org-x-net-vulnerability

Context

We discovered this issue after the branch name was picked up by a downstream build and caused an error due to the unexpected /.

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

Use the santaised dep name for branch creation, this ensure that the branch does not have special characters which could cause issues with other services.
viceice
viceice previously approved these changes Oct 12, 2023
@viceice viceice changed the title Use depNameSanitized in branch name for vulnerability alerts fix(config): Use depNameSanitized` in branch name for vulnerability alerts Oct 12, 2023
@viceice viceice changed the title fix(config): Use depNameSanitized` in branch name for vulnerability alerts fix(config): Use depNameSanitized in branch name for vulnerability alerts Oct 12, 2023
@viceice viceice requested a review from rarkins October 12, 2023 10:32
@rarkins
Copy link
Collaborator

rarkins commented Oct 12, 2023

This looks like the right thing to do, but the question is about disruption to users. Any existing Remediation PR with a special character will be autoclosed and recreated.

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.

that's true. 🤔 make it a feature bump instead of a fix?

@rarkins
Copy link
Collaborator

rarkins commented Oct 12, 2023

I don't think that part matters. I do consider it a fix!

@viceice
Copy link
Member

viceice commented Oct 13, 2023

sure, let's do a fix with major bump

@viceice viceice changed the title fix(config): Use depNameSanitized in branch name for vulnerability alerts fix(config)!: Use depNameSanitized in branch name for vulnerability alerts Oct 13, 2023
@rarkins rarkins added the breaking Breaking change, requires major version bump label Oct 23, 2023
Copy link
Collaborator

@rarkins rarkins left a comment

Choose a reason for hiding this comment

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

Hold for next major release

@rarkins rarkins changed the base branch from main to v38 March 18, 2024 11:25
@rarkins rarkins requested a review from viceice April 14, 2024 07:56
@rarkins rarkins enabled auto-merge (squash) April 14, 2024 07:57
@rarkins rarkins merged commit f9a041d into renovatebot:v38 Apr 14, 2024
27 checks passed
rarkins pushed a commit that referenced this pull request Apr 14, 2024
… alerts (#25166)

Use sanitized depName in vulnerability/remediation branches instead of raw depName. This will result in some open remediation branches being autoclosed and replaced for ecosystems like go in particular which have special characters in depNames.

BREAKING CHANGE: Branch names for remediation will be sanitized to exclude special characters, potentially resulting in some autoclosing/replacing of existing PRs.
rarkins pushed a commit that referenced this pull request Apr 20, 2024
… alerts (#25166)

Use sanitized depName in vulnerability/remediation branches instead of raw depName. This will result in some open remediation branches being autoclosed and replaced for ecosystems like go in particular which have special characters in depNames.

BREAKING CHANGE: Branch names for remediation will be sanitized to exclude special characters, potentially resulting in some autoclosing/replacing of existing PRs.
rarkins pushed a commit that referenced this pull request Apr 21, 2024
… alerts (#25166)

Use sanitized depName in vulnerability/remediation branches instead of raw depName. This will result in some open remediation branches being autoclosed and replaced for ecosystems like go in particular which have special characters in depNames.

BREAKING CHANGE: Branch names for remediation will be sanitized to exclude special characters, potentially resulting in some autoclosing/replacing of existing PRs.
rarkins pushed a commit that referenced this pull request Apr 21, 2024
… alerts (#25166)

Use sanitized depName in vulnerability/remediation branches instead of raw depName. This will result in some open remediation branches being autoclosed and replaced for ecosystems like go in particular which have special characters in depNames.

BREAKING CHANGE: Branch names for remediation will be sanitized to exclude special characters, potentially resulting in some autoclosing/replacing of existing PRs.
rarkins pushed a commit that referenced this pull request Apr 22, 2024
… alerts (#25166)

Use sanitized depName in vulnerability/remediation branches instead of raw depName. This will result in some open remediation branches being autoclosed and replaced for ecosystems like go in particular which have special characters in depNames.

BREAKING CHANGE: Branch names for remediation will be sanitized to exclude special characters, potentially resulting in some autoclosing/replacing of existing PRs.
rarkins pushed a commit that referenced this pull request Apr 26, 2024
… alerts (#25166)

Use sanitized depName in vulnerability/remediation branches instead of raw depName. This will result in some open remediation branches being autoclosed and replaced for ecosystems like go in particular which have special characters in depNames.

BREAKING CHANGE: Branch names for remediation will be sanitized to exclude special characters, potentially resulting in some autoclosing/replacing of existing PRs.
rarkins pushed a commit that referenced this pull request Apr 29, 2024
… alerts (#25166)

Use sanitized depName in vulnerability/remediation branches instead of raw depName. This will result in some open remediation branches being autoclosed and replaced for ecosystems like go in particular which have special characters in depNames.

BREAKING CHANGE: Branch names for remediation will be sanitized to exclude special characters, potentially resulting in some autoclosing/replacing of existing PRs.
rarkins pushed a commit that referenced this pull request May 3, 2024
… alerts (#25166)

Use sanitized depName in vulnerability/remediation branches instead of raw depName. This will result in some open remediation branches being autoclosed and replaced for ecosystems like go in particular which have special characters in depNames.

BREAKING CHANGE: Branch names for remediation will be sanitized to exclude special characters, potentially resulting in some autoclosing/replacing of existing PRs.
rarkins pushed a commit that referenced this pull request May 4, 2024
… alerts (#25166)

Use sanitized depName in vulnerability/remediation branches instead of raw depName. This will result in some open remediation branches being autoclosed and replaced for ecosystems like go in particular which have special characters in depNames.

BREAKING CHANGE: Branch names for remediation will be sanitized to exclude special characters, potentially resulting in some autoclosing/replacing of existing PRs.
rarkins pushed a commit that referenced this pull request May 5, 2024
… alerts (#25166)

Use sanitized depName in vulnerability/remediation branches instead of raw depName. This will result in some open remediation branches being autoclosed and replaced for ecosystems like go in particular which have special characters in depNames.

BREAKING CHANGE: Branch names for remediation will be sanitized to exclude special characters, potentially resulting in some autoclosing/replacing of existing PRs.
rarkins pushed a commit that referenced this pull request May 6, 2024
… alerts (#25166)

Use sanitized depName in vulnerability/remediation branches instead of raw depName. This will result in some open remediation branches being autoclosed and replaced for ecosystems like go in particular which have special characters in depNames.

BREAKING CHANGE: Branch names for remediation will be sanitized to exclude special characters, potentially resulting in some autoclosing/replacing of existing PRs.
rarkins pushed a commit that referenced this pull request May 11, 2024
… alerts (#25166)

Use sanitized depName in vulnerability/remediation branches instead of raw depName. This will result in some open remediation branches being autoclosed and replaced for ecosystems like go in particular which have special characters in depNames.

BREAKING CHANGE: Branch names for remediation will be sanitized to exclude special characters, potentially resulting in some autoclosing/replacing of existing PRs.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
breaking Breaking change, requires major version bump
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants