Skip to content
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.

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

chore: Recommend git clone --recursive for submodules #4036

Merged
merged 2 commits into from
May 2, 2022
Merged

chore: Recommend git clone --recursive for submodules #4036

merged 2 commits into from
May 2, 2022

Conversation

mapmeld
Copy link
Contributor

@mapmeld mapmeld commented Apr 29, 2022

Description

Update our docs where we git clone to include the new submodules with git clone --recursive

Checklist

  • User-facing API changes need the "User-facing API Change" label.
  • Release notes should be added as a separate file under docs/release-notes/.
  • Licenses should be included for new code which was copied and/or modified from any external code.

@mapmeld mapmeld requested a review from hamidzr April 29, 2022 16:38
@cla-bot cla-bot bot added the cla-signed label Apr 29, 2022
@netlify
Copy link

netlify bot commented Apr 29, 2022

Deploy Preview for determined-ui ready!

Name Link
🔨 Latest commit fcf6714
🔍 Latest deploy log https://app.netlify.com/sites/determined-ui/deploys/626c4bd34e9c4900087fca1e
😎 Deploy Preview https://deploy-preview-4036--determined-ui.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Contributor

@hamidzr hamidzr left a comment

Choose a reason for hiding this comment

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

thanks for updating the docs. what does --recursive do? we might want this one instead. --recursive doesn't show up in git clone --help

--recurse-submodules[=<pathspec>]
             After the clone is created, initialize and clone
             submodules within based on the provided pathspec. If no
             pathspec is provided, all submodules are initialized
             and cloned. This option can be given multiple times for
             pathspecs consisting of multiple entries. The resulting
             clone has submodule.active set to the provided
             pathspec, or "." (meaning all submodules) if no
             pathspec is provided.

             Submodules are initialized and cloned using their
             default settings. This is equivalent to running git
             submodule update --init --recursive <pathspec>
             immediately after the clone is finished. This option is
             ignored if the cloned repository does not have a
             worktree/checkout (i.e. if any of --no-checkout/-n,
             --bare, or --mirror is given)

@hamidzr
Copy link
Contributor

hamidzr commented Apr 29, 2022

I'm considering whether we want to add a git submodule update to our get-deps step.

@mapmeld
Copy link
Contributor Author

mapmeld commented Apr 29, 2022

oh I had used --recursive before, it looks like it's only an alias https://explainshell.com/explain?cmd=git+clone+--recursive

I'll update this PR and then if you think it should combine in the git submodule update I can look it up

@hamidzr
Copy link
Contributor

hamidzr commented May 2, 2022

thanks.
re

I'll update this PR and then if you think it should combine in the git submodule update I can look it up

i'll try this in saas and see how that works out first.

@mapmeld mapmeld merged commit 59e5b9b into determined-ai:master May 2, 2022
@mapmeld mapmeld deleted the docs branch May 2, 2022 15:54
@dannysauer dannysauer modified the milestones: 0.0.102, 0.18.0 Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants