Skip to content

refactor: Improve branch/release scripts #762

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

Merged
merged 1 commit into from
Jul 24, 2025

Conversation

Techassi
Copy link
Member

@Techassi Techassi commented Jul 24, 2025

This PR improves a bunch of things:

  • The release branches in the documentation repository now finally uses release-YY.M.X instead of release/YY.M.X to be inline with all other release branches.
  • Converts all variable names to uppercase and improves the naming of some of them.
  • Reports the commit of HEAD and origin/main if they are not in sync
  • Print out the branch the PR should be raised against

@Techassi Techassi requested a review from NickLarsenNZ July 24, 2025 18:58
@Techassi Techassi self-assigned this Jul 24, 2025
@Techassi Techassi added the release-retro/25.7.0 Indicates this issue or PR is part of improvements resulting from the Release Retro 25.7.0 label Jul 24, 2025
Copy link

netlify bot commented Jul 24, 2025

Deploy Preview for stackable-docs ready!

Name Link
🔨 Latest commit 4d8d168
🔍 Latest deploy log https://app.netlify.com/projects/stackable-docs/deploys/6882825a610bf800081a599b
😎 Deploy Preview https://deploy-preview-762--stackable-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Member

@NickLarsenNZ NickLarsenNZ left a comment

Choose a reason for hiding this comment

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

LGTM.

Does it also need changes in the antora yamls?


Also:

  • Will need to checkout branches, and push them with the new name
  • Will need to update branch protection rules (if any)
  • Update any templates that mention using the / notation

@Techassi
Copy link
Member Author

Techassi commented Jul 24, 2025

Does it also need changes in the antora yamls?

No, the new release branch is inserted as others were before. It only uses a hyphen instead of a slash.

Will need to checkout branches, and push them with the new name

No, the old branches can be kept as is. All releases up to 25.3 can continue to use branches with slashes. The new 25.7 release will instead point to a branch with a hyphen.

Update any templates that mention using the / notation

Yes, that's true. But there shouldn't be many mentions afair.

@Techassi Techassi added this pull request to the merge queue Jul 24, 2025
Merged via the queue into main with commit 08c9c35 Jul 24, 2025
6 checks passed
@Techassi Techassi deleted the refactor/improve-branch-release-scripts branch July 24, 2025 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-retro/25.7.0 Indicates this issue or PR is part of improvements resulting from the Release Retro 25.7.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants