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

Update documentation to help transition from manage_externals -> git submodules #137

Closed
mnlevy1981 opened this issue Sep 26, 2024 · 0 comments · Fixed by #144
Closed

Update documentation to help transition from manage_externals -> git submodules #137

mnlevy1981 opened this issue Sep 26, 2024 · 0 comments · Fixed by #144

Comments

@mnlevy1981
Copy link
Collaborator

https://ncar.github.io/CUPiD/#installing walks new users through the process of cloning CUPiD and setting everything up, but existing users who try to run git pull to update their sandbox may run into issues. I just tried this, going from a fresh copy of v0.1.0 to main, and all I saw was a warning that manage_externals was not removed:

$ git checkout main
warning: unable to rmdir 'manage_externals': Directory not empty
Previous HEAD position was 5c2b957 Merge pull request #123 from TeaganKing/cupid_analysis_env
Switched to branch 'main'
Your branch is up to date with 'origin/main'.

But I'm pretty sure there's a situation where the checkout fails altogether - maybe if a file has been modified in ADF or mom6-tools? I think we want the instructions to recommend removing externals/ before checking out main, then doing the git submodule update and also removing manage_externals (if it is still there after git submodule update --init)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant