Fix import_from_git when specifying a tag and cache_path #22133

jenskuhrjorgensen · 2024-07-09T09:11:23Z

Checklist

I've run bundle exec rspec from the root directory to see all new and existing tests pass
I've followed the fastlane code style and run bundle exec rubocop -a to ensure the code style is valid
I see several green ci/circleci builds in the "All checks have passed" section of my PR (connect CircleCI to GitHub if not)
I've read the Contribution Guidelines
I've updated the documentation if necessary.
I've added or updated relevant unit tests.

Motivation and Context

If you run import_from_git with a tag and cache_path like this:

import_from_git(
  url: "https://myprivaterepo",
  branch: "fastlane/1.2.3", # This is a tag, not a branch!
  cache_path: "./cache/fastlane",
)

It fails (for full error log see bottom of post):

...
bundler: failed to load command: fastlane (/Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/bin/fastlane)
/Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane_core/lib/fastlane_core/ui/interface.rb:153:in `shell_error!': [!] Exit status of command 'cd /Users/johndoe/Documents/repos/myrepo/fastlane/cache/fastlane/myprivaterepo && git fetch --all --quiet && git checkout fastlane/0  && git reset --hard && git rebase' was 1 instead of 0. (FastlaneCore::Interface::FastlaneShellError)
HEAD is now at d81cbd8 revert
HEAD is now at d81cbd8 revert
You are not currently on a branch.
Please specify which branch you want to rebase against.
See git-rebase(1) for details.

    git rebase '<branch>'
...

Description

This PR avoids running git rebase when cache_path is provided and branch is actually a git tag and not a branch - because you have to be on a branch in order to do a git rebase.

I've tested my PR by both running import_from_git with the branch parameter being a git tag and a git branch and verified that git rebase is still called when branch is actually a branch and not called when branch is a git tag:

branch is a git branch:

import_from_git(
  url: "https://myprivaterepo",
  branch: "fastlane/some-branch", # This is a branch, not a tag!
  cache_path: "./cache/fastlane",
)

branch is a git tag:

import_from_git(
  url: "https://myprivaterepo",
  branch: "fastlane/1.2.3", # This is a tag, not a branch!
  cache_path: "./cache/fastlane",
)

Testing Steps

See previous description on how to test this.

Full error log

[13:31:51]: -----------------------------
[13:31:51]: --- Step: import_from_git ---
[13:31:51]: -----------------------------
[13:31:51]: Eligible for caching
[13:31:51]: Fetching remote git branches and updating git repo...
[13:31:51]: $ cd /Users/johndoe/Documents/repos/myrepo/fastlane/cache/fastlane/myprivaterepo && git fetch --all --quiet && git checkout fastlane/0  && git reset --hard && git rebase
[13:31:52]: ▸ HEAD is now at d81cbd8 revert
[13:31:52]: ▸ HEAD is now at d81cbd8 revert
[13:31:52]: ▸ You are not currently on a branch.
[13:31:52]: ▸ Please specify which branch you want to rebase against.
[13:31:52]: ▸ See git-rebase(1) for details.
[13:31:52]: ▸ git rebase '<branch>'

Looking for related GitHub issues on fastlane/fastlane...

+-------------------------------------------+
|         Plugin updates available          |
+-----------+--------------+----------------+
| Plugin    | Your Version | Latest Version |
+-----------+--------------+----------------+
| appcenter | 2.0.0        | 2.1.2          |
+-----------+--------------+----------------+
[13:31:52]: To update all plugins, just run
[13:31:52]: $ bundle exec fastlane update_plugins

bundler: failed to load command: fastlane (/Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/bin/fastlane)
/Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane_core/lib/fastlane_core/ui/interface.rb:153:in `shell_error!': [!] Exit status of command 'cd /Users/johndoe/Documents/repos/myrepo/fastlane/cache/fastlane/myprivaterepo && git fetch --all --quiet && git checkout fastlane/0  && git reset --hard && git rebase' was 1 instead of 0. (FastlaneCore::Interface::FastlaneShellError)
HEAD is now at d81cbd8 revert
HEAD is now at d81cbd8 revert
You are not currently on a branch.
Please specify which branch you want to rebase against.
See git-rebase(1) for details.

    git rebase '<branch>'


	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane_core/lib/fastlane_core/ui/ui.rb:17:in `method_missing'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/helper/sh_helper.rb:80:in `sh_control_output'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/helper/sh_helper.rb:12:in `sh'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/fast_file.rb:346:in `block (3 levels) in import_from_git'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane_core/lib/fastlane_core/helper.rb:342:in `with_env_values'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/fast_file.rb:345:in `block (2 levels) in import_from_git'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/fast_file.rb:393:in `block in import_from_git'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/actions/actions_helper.rb:69:in `execute_action'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/fast_file.rb:282:in `import_from_git'
	from Fastfile:4:in `parsing_binding'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/fast_file.rb:61:in `eval'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/fast_file.rb:61:in `block in parse'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/fast_file.rb:50:in `chdir'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/fast_file.rb:50:in `parse'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/fast_file.rb:40:in `initialize'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/lane_manager.rb:14:in `new'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/lane_manager.rb:14:in `cruise_lane'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/command_line_handler.rb:34:in `handle'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/commands_generator.rb:110:in `block (2 levels) in run'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/commander-4.6.0/lib/commander/command.rb:187:in `call'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/commander-4.6.0/lib/commander/command.rb:157:in `run'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/commander-4.6.0/lib/commander/runner.rb:444:in `run_active_command'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane_core/lib/fastlane_core/ui/fastlane_runner.rb:124:in `run!'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/commander-4.6.0/lib/commander/delegates.rb:18:in `run!'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/commands_generator.rb:363:in `run'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/commands_generator.rb:43:in `start'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/fastlane/lib/fastlane/cli_tools_distributor.rb:123:in `take_off'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/gems/fastlane-2.221.1/bin/fastlane:23:in `<top (required)>'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/bin/fastlane:25:in `load'
	from /Users/johndoe/Documents/repos/myrepo/gems/ruby/3.2.0/bin/fastlane:25:in `<top (required)>'
	from /Users/johndoe/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.13/lib/bundler/cli/exec.rb:58:in `load'
	from /Users/johndoe/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.13/lib/bundler/cli/exec.rb:58:in `kernel_load'
	from /Users/johndoe/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.13/lib/bundler/cli/exec.rb:23:in `run'
	from /Users/johndoe/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.13/lib/bundler/cli.rb:455:in `exec'
	from /Users/johndoe/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.13/lib/bundler/vendor/thor/lib/thor/command.rb:28:in `run'
	from /Users/johndoe/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.13/lib/bundler/vendor/thor/lib/thor/invocation.rb:127:in `invoke_command'
	from /Users/johndoe/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.13/lib/bundler/vendor/thor/lib/thor.rb:527:in `dispatch'
	from /Users/johndoe/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.13/lib/bundler/cli.rb:35:in `dispatch'
	from /Users/johndoe/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.13/lib/bundler/vendor/thor/lib/thor/base.rb:584:in `start'
	from /Users/johndoe/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.13/lib/bundler/cli.rb:29:in `start'
	from /Users/johndoe/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.13/exe/bundle:28:in `block in <top (required)>'
	from /Users/johndoe/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.13/lib/bundler/friendly_errors.rb:117:in `with_friendly_errors'
	from /Users/johndoe/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.13/exe/bundle:20:in `<top (required)>'
	from /Users/johndoe/.rbenv/versions/3.2.3/bin/bundle:25:in `load'
	from /Users/johndoe/.rbenv/versions/3.2.3/bin/bundle:25:in `<main>'

Fix tag check after refactor to use `git rev-parse` because it will now return "HEAD" instead of an empty string when the current ref is a git tag.

jenskuhrjorgensen · 2024-09-09T09:53:13Z

@oct0f1sh thanks for fixing the CircleCI checks! How do I rerun the checks for my PR so my PR it appears "green"? Do I have to make a new commit to it?

…cache

jenskuhrjorgensen · 2024-09-09T10:11:09Z

Nevermind, I found the "Sync fork" button in my PR which retriggered the CI checks 👍

jenskuhrjorgensen · 2024-09-19T18:08:40Z

@joshdholtz it looks like @oct0f1sh has become inactive on GitHub. Maybe you or some other maintainer can give this PR a quick look?

Thanks in advance.

lucgrabowski

Thank you for your contribution 💪. Looks good to me :)

jenskuhrjorgensen · 2024-09-26T05:35:40Z

Thanks a lot @lucgrabowski <3

Together with this PR I also created another related PR about adding support for git_basic_authorization. Maybe you could also have a look at that at some point?
#22135

Avoid calling git rebase for tags

b04df72

jenskuhrjorgensen changed the title ~~Avoid calling git rebase for tags~~ Fix import_from_git when specifying a tag and cache_path Jul 9, 2024

jenskuhrjorgensen mentioned this pull request Jul 9, 2024

Fix import_from_git when specifying a tag and cache_path #22121

Closed

6 tasks

jenskuhrjorgensen added 4 commits July 9, 2024 13:58

Fix tag check after refactor

8cdad5a

Fix tag check after refactor to use `git rev-parse` because it will now return "HEAD" instead of an empty string when the current ref is a git tag.

Fix typo

b71d9f6

Fix rubocop

e319d2c

Simplify code

8c5b8fd

oct0f1sh mentioned this pull request Jul 11, 2024

CircleCI PR check uses unsupported Ruby version #22141

Closed

4 tasks

Merge branch 'fastlane:master' into fix/import_from_git-with-tag-and-…

b0589db

…cache

lucgrabowski approved these changes Sep 25, 2024

View reviewed changes

lucgrabowski merged commit 0f7c6a4 into fastlane:master Sep 25, 2024
3 checks passed

github-actions bot mentioned this pull request Sep 26, 2024

Version bump to 2.223.0 #22251

Merged

revolter mentioned this pull request Oct 11, 2024

Using import_from_git with version tag #21142

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix import_from_git when specifying a tag and cache_path #22133

Fix import_from_git when specifying a tag and cache_path #22133

Uh oh!

jenskuhrjorgensen commented Jul 9, 2024 •

edited by revolter

Loading

Uh oh!

jenskuhrjorgensen commented Sep 9, 2024

Uh oh!

jenskuhrjorgensen commented Sep 9, 2024

Uh oh!

jenskuhrjorgensen commented Sep 19, 2024

Uh oh!

lucgrabowski left a comment

Uh oh!

Uh oh!

jenskuhrjorgensen commented Sep 26, 2024 •

edited

Loading

Uh oh!

Uh oh!

Fix import_from_git when specifying a tag and cache_path #22133

Fix import_from_git when specifying a tag and cache_path #22133

Uh oh!

Conversation

jenskuhrjorgensen commented Jul 9, 2024 • edited by revolter Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Motivation and Context

Description

Testing Steps

Uh oh!

jenskuhrjorgensen commented Sep 9, 2024

Uh oh!

jenskuhrjorgensen commented Sep 9, 2024

Uh oh!

jenskuhrjorgensen commented Sep 19, 2024

Uh oh!

lucgrabowski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jenskuhrjorgensen commented Sep 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jenskuhrjorgensen commented Jul 9, 2024 •

edited by revolter

Loading

jenskuhrjorgensen commented Sep 26, 2024 •

edited

Loading