feat: Make flub release request bump type lazily #23096
Open
+75
−51
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
area: build
CraigMacomber
commented
Nov 14, 2024
Comment on lines
-35
to
-62
| const { bumpType: inputBumpType, context, releaseVersion } = data; | ||
|
|
||
| const currentBranch = await context.gitRepo.getCurrentBranchName(); | ||
| const currentVersion = releaseVersion; | ||
| const bumpedMajor = bumpVersionScheme(currentVersion, "major"); | ||
| const bumpedMinor = bumpVersionScheme(currentVersion, "minor"); | ||
| const bumpedPatch = bumpVersionScheme(currentVersion, "patch"); | ||
|
|
||
| // If an bumpType was set in the handler data, use it. Otherwise set it as the default for the branch. If there's | ||
| // no default for the branch, ask the user. | ||
| let bumpType = inputBumpType ?? getDefaultBumpTypeForBranch(currentBranch); | ||
| if (inputBumpType === undefined) { | ||
| const selectedBumpType: VersionBumpType = await rawlist({ | ||
| choices: [ | ||
| { value: "major", name: `major (${currentVersion} => ${bumpedMajor.version})` }, | ||
| { value: "minor", name: `minor (${currentVersion} => ${bumpedMinor.version})` }, | ||
| { value: "patch", name: `patch (${currentVersion} => ${bumpedPatch.version})` }, | ||
| ], | ||
| message: `The current branch is '${currentBranch}'. The default bump type for that branch is '${bumpType}', but you can change it now if needed.`, | ||
| }); | ||
| bumpType = selectedBumpType; | ||
| // eslint-disable-next-line require-atomic-updates | ||
| data.bumpType = selectedBumpType; | ||
| } | ||
|
|
||
| if (bumpType === undefined) { | ||
| throw new Error(`bumpType is undefined.`); | ||
| } |
There was a problem hiding this comment.
All this logical basically does nothing because inputBumpType can't be undefined based on its type. This also seems redundant with the logic which computes the inputBumpType. Logic has been simplified to use the already provided bump type (which will lazily prompt if needed)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Make flub release request bump type lazily.
Reviewer Guidance
The review process is outlined on this wiki page.
I don't know a great way to test this locally easily, since running it on my branch doesn't hit very many of the cases since it objects to the branch it's on. I can confirm it prompts if I disable checks, but I'm not sure if it would skip prompting run on a release that's not released where the bump type should not be needed.