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

Add support for running with Docker #3

Merged
merged 4 commits into from
Oct 30, 2020
Merged

Add support for running with Docker #3

merged 4 commits into from
Oct 30, 2020

Conversation

billsacks
Copy link
Member

Add ability to use a Docker image to do the documentation build.

For now, this assumes the use of the escomp/base docker image.

(I'm opening this PR for documentation purposes; it doesn't require review, and I'll merge it myself.)

This will be needed in an upcoming change, where I do some initial work
before running the actual command.
The need for this is subtle: For CTSM, the documentation build invokes
'git lfs pull'. However, when doing the documentation build from a git
worktree, the .git directory is replaced with a text file giving the
absolute path to the parent git repository, e.g., 'gitdir:
/Users/sacks/ctsm/ctsm0/.git/worktrees/ctsm5'. So when trying to execute
a git command from within the Docker image, you get a message like,
'fatal: not a git repository:
/Users/sacks/ctsm/ctsm0/.git/worktrees/ctsm5', because in Docker-land,
this path doesn't exist. To work around this problem, we create a sym
link in Docker's file system with the appropriate mapping. For example,
if the local file system's mount-point is /path/to/foo, then we create a
sym link at /path/to/foo in Docker's file system, pointing to the home
directory in the Docker file system.
This is needed for output to be colorful
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 this pull request may close these issues.

1 participant