feat(git): add support to only fetch repositories #918
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
add `fetch_only` to config in case user wants to only fetch, not already pull changes Closes topgrade-rs#806
SteveLauC
reviewed
Sep 28, 2024
| @@ -295,16 +295,24 @@ impl RepoStep { | |||
| async fn pull_repo<P: AsRef<Path>>(&self, ctx: &ExecutionContext<'_>, repo: P) -> Result<()> { | |||
There was a problem hiding this comment.
Let's update the function name and its doc as well:
/// Try to pull a repo, or fetch it if `fetch_only` is enabled.
async fn pull_or_fetch_repo<P: AsRef<Path>>(&self, ctx: &ExecutionContext<'_>, repo: P) -> Result<()> {
SteveLauC
reviewed
Sep 28, 2024
| @@ -196,6 +196,8 @@ | |||
| # Arguments to pass Git when pulling Repositories | |||
| # arguments = "--rebase --autostash" | |||
|
|
|||
| # Whether to fetch only instead of pulling remote changes | |||
There was a problem hiding this comment.
Can we give this config a default value false?
There was a problem hiding this comment.
BTW, for all the docs under [git], we need to update them, pull or fetch
Comment on lines
+1055
to
+1058
| /// Only fetch repo's instead of pulling | ||
| pub fn git_fetch_only(&self) -> Option<&bool> { | ||
| self.config_file.git.as_ref().and_then(|git| git.fetch_only.as_ref()) | ||
| } |
There was a problem hiding this comment.
If a default value is given, we can:
Suggested change
| /// Only fetch repo's instead of pulling | |
| pub fn git_fetch_only(&self) -> Option<&bool> { | |
| self.config_file.git.as_ref().and_then(|git| git.fetch_only.as_ref()) | |
| } | |
| /// Only fetch repo's instead of pulling | |
| pub fn git_fetch_only(&self) -> bool { | |
| self.config_file.git.as_ref().and_then(|git| git.fetch_only).unwrap_or(false) | |
| } |
| .stdin(Stdio::null()) | ||
| .current_dir(&repo) | ||
| .args(["pull", "--ff-only"]); | ||
| } |
There was a problem hiding this comment.
Looks like the submodule update procedure should also be considered as a part of git pull?
There was a problem hiding this comment.
Let's update pull_repos() function as well
- Rename it to
pull_or_fetch_repos() - Update the doc
- Update the outputs exclusive to
git pull
SteveLauC
reviewed
Sep 28, 2024
|
Thanks for the PR, left some comments:) |
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 does this PR do
add
fetch_onlyto config in case user wants to only fetch, not already pull changesStandards checklist
CONTRIBUTING.mdFor new steps
--dry-runoption works with this step--yesoption works with this step if it is supported bythe underlying command
If you developed a feature or a bug fix for someone else and you do not have the
means to test it, please tag this person here.