Skip to content

feat: Add --commit option to git subrepo pull command #620

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat: Add --commit option to git subrepo pull command #620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0598599
feat: Add --commit option to git subrepo pull command
Gilad-Sharaby May 30, 2024
09dd372
feat: Add --commit option to git subrepo pull command - fixed fetch f…
Gilad-Sharaby Jun 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 75 additions & 53 deletions lib/git-subrepo
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

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

git subrepo pull --commit would override any --branch option. There isn't any comments to the user or the application indicting this is by design.

Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Options:
h Show the command summary
help Help overview
version Print the git-subrepo version number

a,all Perform command on all current subrepos
A,ALL Perform command on all subrepos and subsubrepos
b,branch= Specify the upstream branch to push/pull/fetch
Expand All @@ -76,8 +76,9 @@ m,message= Specify a commit message
file= Specify a commit message file
r,remote= Specify the upstream remote to push/pull/fetch
s,squash Squash commits on push
c,commit= Specify a commit to pull
u,update Add the --branch and/or --remote overrides to .gitrepo

q,quiet Show minimal output
v,verbose Show verbose output
d,debug Show the actual commands used
Expand All @@ -89,63 +90,64 @@ x,DEBUG Turn on -x Bash debugging
#------------------------------------------------------------------------------
main() {
# Define global variables:
local command= # Subrepo subcommand to run
local command_arguments=() # Command args after getopt parsing
local commit_msg_args=() # Arguments to show in the commit msg
local subrepos=() # List of multiple subrepos

local all_wanted=false # Apply command to all subrepos
local ALL_wanted=false # Apply command to all subrepos and subsubrepos
local force_wanted=false # Force certain operations
local fetch_wanted=false # Fetch requested before a command
local squash_wanted=false # Squash commits on push
local update_wanted=false # Update .gitrepo with --branch and/or --remote

local quiet_wanted=false # Output should be quiet
local verbose_wanted=false # Output should be verbose
local debug_wanted=false # Show debug messages

local subdir= # Subdirectory of the subrepo being used
local subref= # Valid git ref format of subdir
local gitrepo= # Path to .gitrepo file
local worktree= # Worktree created by 'git worktree'
local command= # Subrepo subcommand to run
local command_arguments=() # Command args after getopt parsing
local commit_msg_args=() # Arguments to show in the commit msg
local subrepos=() # List of multiple subrepos

local all_wanted=false # Apply command to all subrepos
local ALL_wanted=false # Apply command to all subrepos and subsubrepos
local force_wanted=false # Force certain operations
local fetch_wanted=false # Fetch requested before a command
local squash_wanted=false # Squash commits on push
local update_wanted=false # Update .gitrepo with --branch and/or --remote

local quiet_wanted=false # Output should be quiet
local verbose_wanted=false # Output should be verbose
local debug_wanted=false # Show debug messages

local subdir= # Subdirectory of the subrepo being used
local subref= # Valid git ref format of subdir
local gitrepo= # Path to .gitrepo file
local worktree= # Worktree created by 'git worktree'
local start_pwd
start_pwd=$(pwd) # Store the original directory
start_pwd=$(pwd) # Store the original directory

local original_head_commit= # HEAD commit id at start of command
local original_head_branch= # HEAD ref at start of command
local upstream_head_commit= # HEAD commit id from a subrepo fetch
local original_head_commit= # HEAD commit id at start of command
local original_head_branch= # HEAD ref at start of command
local upstream_head_commit= # HEAD commit id from a subrepo fetch

local subrepo_remote= # Remote url for subrepo's upstream repo
local subrepo_branch= # Upstream branch to clone/push/pull
local subrepo_commit= # Upstream HEAD from previous clone/pull
local subrepo_parent= # Local commit from before previous clone/pull
local subrepo_former= # A retired gitrepo key that might still exist
local subrepo_remote= # Remote url for subrepo's upstream repo
local subrepo_branch= # Upstream branch to clone/push/pull
local subrepo_commit= # Upstream HEAD from previous clone/pull
local subrepo_commit_specified= # Commit specified by --commit
local subrepo_parent= # Local commit from before previous clone/pull
local subrepo_former= # A retired gitrepo key that might still exist

local refs_subrepo_branch= # A subrepo ref -> commit of branch/pull command
local refs_subrepo_commit= # A subrepo ref -> commit last merged
local refs_subrepo_fetch= # A subrepo ref -> FETCH_HEAD after fetch
local refs_subrepo_push= # A subrepo ref -> branch after push
local refs_subrepo_branch= # A subrepo ref -> commit of branch/pull command
local refs_subrepo_commit= # A subrepo ref -> commit last merged
local refs_subrepo_fetch= # A subrepo ref -> FETCH_HEAD after fetch
local refs_subrepo_push= # A subrepo ref -> branch after push

local override_remote= # Remote specified with -r
local override_branch= # Remote specified with -b
local override_remote= # Remote specified with -r
local override_branch= # Remote specified with -b

local edit_wanted=false # Edit commit message using -e
local wanted_commit_message= # Custom commit message using -m
local commit_msg_file= # Custom commit message using --file
local edit_wanted=false # Edit commit message using -e
local wanted_commit_message= # Custom commit message using -m
local commit_msg_file= # Custom commit message using --file

local join_method= # Current join method (rebase/merge)
local join_method= # Current join method (rebase/merge)

local FAIL=true # Flag for RUN: fail on error
local OUT=false # Flag for RUN: put output in $output
local TTY=false # Flag for RUN: print output directly
local SAY=true # Flag for RUN: print command for verbose
local EXEC=false # Flag for RUN: run subprocess
local OK=true # Flag that commands have succeeded
local CODE=0 # Failure reason code
local INDENT= # Verbose indentation
local FAIL=true # Flag for RUN: fail on error
local OUT=false # Flag for RUN: put output in $output
local TTY=false # Flag for RUN: print output directly
local SAY=true # Flag for RUN: print command for verbose
local EXEC=false # Flag for RUN: run subprocess
local OK=true # Flag that commands have succeeded
local CODE=0 # Failure reason code
local INDENT= # Verbose indentation

local git_version= # Git version in use
local git_version= # Git version in use

# Check environment and parse CLI options:
assert-environment-ok
Expand Down Expand Up @@ -715,15 +717,30 @@ subrepo:fetch() {
fi

o "Fetch the upstream: $subrepo_remote ($subrepo_branch)."
RUN git fetch --no-tags --quiet "$subrepo_remote" "$subrepo_branch"
OK || return
if [[ -n $subrepo_commit_specified ]]; then
o "Fetching specific commit $subrepo_commit_specified"
RUN git fetch --no-tags --quiet "$subrepo_remote" "$subrepo_commit_specified"
else
o "Fetching branch $subrepo_branch"
RUN git fetch --no-tags --quiet "$subrepo_remote" "$subrepo_branch"
fi

if ! OK; then
error "Failed to fetch the upstream."
fi

o "Get the upstream subrepo HEAD commit."
OUT=true RUN git rev-parse FETCH_HEAD^0
upstream_head_commit=$output

if [[ -z $upstream_head_commit ]]; then
error "Failed to resolve the fetched commit."
fi

o "Fetched commit: $upstream_head_commit"

o "Create ref '$refs_subrepo_fetch'."
git:make-ref "$refs_subrepo_fetch" FETCH_HEAD^0
git:make-ref "$refs_subrepo_fetch" "$upstream_head_commit"
}

# Create a subrepo branch containing all changes
Expand Down Expand Up @@ -1063,6 +1080,9 @@ get-command-options() {
override_branch=$1
commit_msg_args+=("--branch=$1")
shift ;;
-c) subrepo_commit_specified=$1
commit_msg_args+=("--commit=$1")
shift ;;
-e) edit_wanted=true ;;
-f) force_wanted=true
commit_msg_args+=("--force") ;;
Expand Down Expand Up @@ -1186,6 +1206,8 @@ command-prepare() {

# Do the setup steps needed by most of the subrepo subcommands:
command-setup() {
subrepo_commit_specified=${subrepo_commit_specified-}

get-params "$@"

check-and-normalize-subdir
Expand Down
9 changes: 4 additions & 5 deletions lib/git-subrepo.d/help-functions.bash
View file
Open in desktop
Copy link
Collaborator

@admorgan admorgan Jul 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

help-function.bash is a generated file. These changes need to be made at the source of that generation. Use 'make update` to force the generation of these files.

Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ help:config() {
help:fetch() {
cat <<'...'

Usage: git subrepo fetch <subdir>|--all [-r <remote>] [-b <branch>]
Usage: git subrepo fetch <subdir>|--all [-r <remote>] [-b <branch>] [--commit=<commit-hash>]


Fetch the remote/upstream content for a subrepo.
Expand All @@ -152,7 +152,7 @@ help:fetch() {
`subrepo/<subdir>`. These are temporary and you can easily remove them with
the subrepo `clean` command.

The `fetch` command accepts the `--all`, `--branch=` and `--remote=` options.
The `fetch` command accepts the `--all`, `--branch=`, `--commit=`, and `--remote=` options.
...
}

Expand Down Expand Up @@ -205,8 +205,7 @@ help:init() {

help:pull() {
cat <<'...'

Usage: git subrepo pull <subdir>|--all [-M|-R|-f] [-m <msg>] [--file=<msg file>] [-e] [-b <branch>] [-r <remote>] [-u]
Usage: git subrepo pull <subdir>|--all [-M|-R|-f] [-m <msg>] [--file=<msg file>] [-e] [-b <branch>] [-r <remote>] [-u] [--commit=<commit-hash>]


Update the subrepo subdir with the latest upstream changes.
Expand Down Expand Up @@ -252,7 +251,7 @@ help:pull() {

The set of commands used above are described in detail below.

The `pull` command accepts the `--all`, `--branch=`, `--edit`, `--file`,
The `pull` command accepts the `--all`, `--branch=`, `--commit=`, `--edit`, `--file`,
`--force`, `--message=`, `--remote=` and `--update` options.
...
}
Expand Down