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

Replace "/" from Renovate Branch Prefix with "--" to be URL Safe #76

Merged
merged 2 commits into from
Nov 8, 2022

Conversation

jahredhope
Copy link
Member

@jahredhope jahredhope commented Nov 6, 2022

Branches can be used as identifiers for things like preview environments.
This can mean that the branch name appears in URLs, either as subdomains, paths or query parameters.

  • cool-feature.example.com
  • example.com/cool-feature
  • example.com/path?version=cool-feature

In these cases it's nice to have URLs with limited special characters.

Current
Currently renovate branches have / added which results in URLs like:

  • renovate%2Fcool-feature.example.com
  • example.com/renovate%2Fcool-feature
  • example.com/path?version=renovate%2Fcool-feature

With Change

With this change it'll instead use --:

  • renovate--cool-feature.example.com
  • example.com/renovate--cool-feature
  • example.com/path?version=renovate--cool-feature

Change

Default for Branch Prefix is renovate/
This PR changes is to renovate--

Precedence

This aligns to the SEEK Renovate config that sets the value to the same: https://github.com/seek-oss/renovate-config-seek/blob/eb02ac2d5b72828c9365020a5b44f37ab5921323/package.json#L28

This has been raised previously and was closed: #7 though allowed re-open if it's still an issue which I believe it is.

@jahredhope jahredhope requested a review from a team as a code owner November 6, 2022 23:10
@jahredhope jahredhope changed the title Replace "/" from in Renovate Branch Prefix with "--" to be URL Safe Replace "/" from Renovate Branch Prefix with "--" to be URL Safe Nov 7, 2022
72636c added a commit to seek-oss/skuba that referenced this pull request Nov 7, 2022
72636c added a commit to seek-oss/skuba that referenced this pull request Nov 7, 2022
@jahredhope jahredhope merged commit a9ac9cc into master Nov 8, 2022
@jahredhope jahredhope deleted the url-safe-branch branch November 8, 2022 22:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants