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

chore: Script to create a hot fix #3502

Merged
merged 8 commits into from
Dec 28, 2023
Merged

chore: Script to create a hot fix #3502

merged 8 commits into from
Dec 28, 2023

Conversation

brustolin
Copy link
Contributor

@brustolin brustolin commented Dec 15, 2023

Added a script that helps creating a hot fix from a specific version with a specific PR commit.

usage (from repo root directory):

./scripts/hot-fix.sh <version from> <new version> <commit hash>

To release 8.17.2 with #3501

./scripts/hot-fix.sh 8.17.1 8.17.2 aea5987

After running the script we need to run the release action with hotfix/<new version> branch for Use workflow from
#skip-changelog

Copy link
Member

@armcknight armcknight left a comment

Choose a reason for hiding this comment

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

It sounds like this would be a new release process from just merging a PR to master, because we want to avoid shipping other new features along with a hotfix patch?

Could you add something to develop-docs/README.md that outlines the standard and hotfix processes?

Maybe it could also open a PR back into main after pushing to $hotfix_branch on line 22 using gh pr create, or would that be done automatically from the release job?

@brustolin
Copy link
Contributor Author

It sounds like this would be a new release process from just merging a PR to master, because we want to avoid shipping other new features along with a hotfix patch?

From time to time, I am asked to do this, and I always forget how to. The script is designed to make it easy to create a hotfix release from one PR. This is not a process that we need to follow.

Maybe it could also open a PR back into main after pushing to $hotfix_branch on line 22 using gh pr create, or would that be done automatically from the release job?

We don't need a new PR for hotfixes, all the code should have being reviewed already.

@philipphofmann
Copy link
Member

philipphofmann commented Dec 18, 2023

@brustolin, I think we should rename the script to something like create-hotfix-cherry-pick-branch.sh to avoid confusion, as it only creates the branch. I agree with @armcknight that we should add a note to the internal develop docs or explain the usage in the script.

./scripts/hot-fix.sh <version from> <new version> <commit hash>

@armcknight, there are multiple ways to create a hotfix; we don't have to use this script. You can also do the process manually. I'm okay with merging this if it makes releasing hotfixes easier for @brustolin.

Copy link
Member

@philipphofmann philipphofmann left a comment

Choose a reason for hiding this comment

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

LGTM

@brustolin brustolin merged commit 48e8c2e into main Dec 28, 2023
4 checks passed
@brustolin brustolin deleted the chore/hot-fix-script branch December 28, 2023 09:34
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.

3 participants