feat: support pre-release versions in self-update command
#4022
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
This improves performance by avoiding unnecessary target version search when the version is specified explicitly. Also, this removes unnecessary local variable `targetVersion` which has been semantically equal to `desiredVersion`.
Just placed `VersionScope` type definition and relevant utility function next to each other.
The new method `findReleaseVersion` contains machinery to traverse GitHub releases in a pagination mode and get the first one matching a given predicate.
To reduce semantic load of the `SelfUpdateCommand` class. Those helpers are generic and not tightly related to the semantics of the `self-update` command.
That method was tightly connected to the logic of the caller, and was used by the only caller.
To isolate the artifacts details collection and return the details as a structured object. The artifacts details can differ depending on the `desiredVersion` type (edge/pre-release/release). This change will be used to support pre-prelease versions in `self-update` command.
Walther
reviewed
Mar 29, 2023
Empty message on the `error` level gets rendered as `✖ undefined`. That might be confusing.
Orzelius
reviewed
Mar 29, 2023
core/src/commands/self-update.ts
Outdated
| @@ -351,35 +351,52 @@ export class SelfUpdateCommand extends Command<SelfUpdateArgs, SelfUpdateOpts> { | |||
| ) | |||
| } | |||
|
|
|||
| const targetRelease = await this.findRelease((release) => { | |||
There was a problem hiding this comment.
I think this deserves a unit test or two
There was a problem hiding this comment.
Good point! Actually, we need to test the predicate here. The machinery around it is quite trivial.
There was a problem hiding this comment.
Added tests in 5fef833
Co-authored-by: Orzelius <[email protected]>
vvagaytsev
force-pushed
the
feat/self-update-to-prerelease
branch
from
c062f8b to
29bc18b
Compare
To correctly handle `0.x` -> `0.y` updates as major ones.
Walther
reviewed
Mar 31, 2023
Comment on lines
404
to
414
| it("should skip an older pre-release version", () => { | ||
| expectSkipped({ tag_name: "test", draft: true, prerelease: false }, semver.parse("0.13.0")!, "patch") | ||
| }) | ||
|
|
||
| it("should skip the same pre-release version", () => { | ||
| expectSkipped({ tag_name: "test", draft: true, prerelease: false }, semver.parse("0.13.0")!, "patch") | ||
| }) | ||
|
|
||
| it("should skip a newer pre-release version", () => { | ||
| expectSkipped({ tag_name: "test", draft: true, prerelease: false }, semver.parse("0.13.0")!, "patch") | ||
| }) |
There was a problem hiding this comment.
possible copy-paste issue - these test cases look identical
There was a problem hiding this comment.
Thanks! Fixed that in 144cfee
Walther
approved these changes
Mar 31, 2023
vvagaytsev
added a commit
that referenced
this pull request
Mar 31, 2023
* perf: got rid of unnecessary HTTP requests This improves performance by avoiding unnecessary target version searches when the version is specified explicitly. Also, this removes the unnecessary local variable `targetVersion` which has been semantically equal to `desiredVersion`. * refactor: utility function to find a release by a predicate The new method `findReleaseVersion` contains machinery to traverse GitHub releases in a pagination mode and get the first one matching a given predicate. * refactor: move GH helpers to a dedicated namespace To reduce the semantic load of the `SelfUpdateCommand` class. Those helpers are generic and not tightly related to the semantics of the `self-update` command. * refactor: inline `targetVersionMatches` method That method was tightly connected to the caller's logic, and was used by the only caller. * refactor: helper function to get release artifact details To isolate the artifacts details collection and return the details as a structured object. The artifacts details can differ depending on the `desiredVersion` type (edge/pre-release/release). This change will support pre-prelease versions in `self-update` command. * refactor: helper function to identify pre-release versions * feat: support pre-release versions in `self-update` command * chore: remove unnecessary log line An empty message on the `error` level gets rendered as `✖ undefined`. That might be not very clear. * fix: fix version comparing logic To correctly handle `0.x` -> `0.y` updates as major ones. --------- Co-authored-by: Orzelius <[email protected]>
vvagaytsev
added a commit
that referenced
this pull request
Mar 31, 2023
* perf: got rid of unnecessary HTTP requests This improves performance by avoiding unnecessary target version searches when the version is specified explicitly. Also, this removes the unnecessary local variable `targetVersion` which has been semantically equal to `desiredVersion`. * refactor: utility function to find a release by a predicate The new method `findReleaseVersion` contains machinery to traverse GitHub releases in a pagination mode and get the first one matching a given predicate. * refactor: move GH helpers to a dedicated namespace To reduce the semantic load of the `SelfUpdateCommand` class. Those helpers are generic and not tightly related to the semantics of the `self-update` command. * refactor: inline `targetVersionMatches` method That method was tightly connected to the caller's logic, and was used by the only caller. * refactor: helper function to get release artifact details To isolate the artifacts details collection and return the details as a structured object. The artifacts details can differ depending on the `desiredVersion` type (edge/pre-release/release). This change will support pre-prelease versions in `self-update` command. * refactor: helper function to identify pre-release versions * feat: support pre-release versions in `self-update` command * chore: remove unnecessary log line An empty message on the `error` level gets rendered as `✖ undefined`. That might be not very clear. * fix: fix version comparing logic To correctly handle `0.x` -> `0.y` updates as major ones. --------- Co-authored-by: Orzelius <[email protected]>
This was referenced May 11, 2023
Closed
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.
What this PR does / why we need it:
To be able to update to the
0.13pre-releases from0.12.xusinggarden self-updatecommand.This PR also contains some refactoring.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
The commits will be squashed before the merge. See individual commits for details.