feat: add check updates command #577
Merged
Conversation
This file contains hidden or 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
alexng353
force-pushed
the
alex/check-updates
branch
from
b2f3436 to
dbe15b4
Compare
brody192
changed the title
alexng353
changed the title
coffee-cup
reviewed
Dec 9, 2024
coffee-cup
reviewed
Jan 8, 2025
simplified check_updates command fix: more user-friendly error message for check_updates on Config write failure
alexng353
force-pushed
the
alex/check-updates
branch
from
ff13a84 to
568c2d4
Compare
Merge conflict rectified via rebase. Apologies for the initial poor quality of this PR; most of it was discussed over Discord, and I didn't put the effort into reflecting the information here. |
Milo123459
reviewed
Feb 16, 2025
feat: check for updates in background and print on next run remove updates check from init, link and run move functions around in main.rs
alexng353
force-pushed
the
alex/check-updates
branch
from
79655eb to
3a86854
Compare
coffee-cup
approved these changes
Feb 28, 2025
src/main.rs
Outdated
Comment on lines
127
to
146
| // Trace from where Args::parse() bubbles an error to where it gets caught | ||
| // and handled. | ||
| // | ||
| // https://github.com/clap-rs/clap/blob/cb2352f84a7663f32a89e70f01ad24446d5fa1e2/clap_builder/src/derive.rs#L30-L42 | ||
| // https://github.com/clap-rs/clap/blob/cb2352f84a7663f32a89e70f01ad24446d5fa1e2/clap_builder/src/error/mod.rs#L233-L237 | ||
| // | ||
| // This code tells us what exit code to use: | ||
| // https://github.com/clap-rs/clap/blob/cb2352f84a7663f32a89e70f01ad24446d5fa1e2/clap_builder/src/error/mod.rs#L221-L227 | ||
| // | ||
| // https://github.com/clap-rs/clap/blob/cb2352f84a7663f32a89e70f01ad24446d5fa1e2/clap_builder/src/error/mod.rs#L206-L208 | ||
| // | ||
| // This code tells us what stream to print the error to: | ||
| // https://github.com/clap-rs/clap/blob/cb2352f84a7663f32a89e70f01ad24446d5fa1e2/clap_builder/src/error/mod.rs#L210-L215 | ||
| // | ||
| // pub(crate) fn stream(&self) -> Stream { | ||
| // match self.kind() { | ||
| // ErrorKind::DisplayHelp | ErrorKind::DisplayVersion => Stream::Stdout, | ||
| // _ => Stream::Stderr, | ||
| // } | ||
| // } |
There was a problem hiding this comment.
Can this be removed? What is it for?
There was a problem hiding this comment.
I can remove it, but it's helpful for future devs if they want to look into the reasoning behind the main file's error handling
There was a problem hiding this comment.
I think its okay to leave a comment with a link, but this big block is unnecessary IMO.
coffee-cup
approved these changes
Mar 13, 2025
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.
This PR adds automatic (daily) checks for new updates for the CLI, only in interactive mode. Alternatively, a user may manually check for updates using the
railway check-updatescommand.Automatic daily checks run in interactive mode, in the background, for any command called. If a new version is detected, the CLI will push a message to the user (similar to NPM) that requests they update their CLI.
Manual checks can be run as follows:
This is what the check-updates command looks like when the version has changed:
This is what the check-updates command looks like when the version has not changed:
This is what the automatic check looks like when the check detects that the version has changed:
The data is grabbed (rather slowly) via the GitHub API (endpoint https://api.github.com/repos/railwayapp/cli/releases/latest), which takes around 700ms to process. This is why we run the check in the background, and even then, we only run it daily.
First run:
Second run: