Makefile.inc

# SSH Agent Socket
ifeq (${OS},Windows_NT)         # WSL2 (Windows)
    SSH_AGENT_SOCK := ${SSH_AUTH_SOCK}
else
    UNAME_S := $(shell uname -s)
    ifeq (${UNAME_S},Darwin)    # macOS
        SSH_AGENT_SOCK := /run/host-services/ssh-auth.sock
    else                        # Linux
        SSH_AGENT_SOCK := ${SSH_AUTH_SOCK}
    endif
endif

# Builds the Docker image and outputs the hash of the built image
DOCKER_BUILD_CMD := docker build --quiet \
  --build-arg DOCS=${DOCS} \
  --build-arg PORT=${PORT} \
  --build-arg TOOLS=${TOOLS} \
  --build-arg REQUIREMENTS=${REQUIREMENTS} \
  --file ${DOCKERFILE} \
  ${ROOT}/${DOCS} | head -n 1
# Runs Docker with the specified image,
#   mounting the Git root directory
#   mounting the known_hosts (for GitHub authentication)
#   mounting the SSH agent socket (for GitHub authentication)
DOCKER_BASE_CMD := docker run --rm -it -p ${PORT}:${PORT} \
  -v ${ROOT}:/repo:ro \
  -v ~/.ssh/known_hosts:/root/.ssh/known_hosts:ro \
  -v ${SSH_AGENT_SOCK}:/ssh-agent:ro --env SSH_AUTH_SOCK=/ssh-agent \
  $(or $(shell ${DOCKER_BUILD_CMD}), $(error "Command failed: ${DOCKER_BUILD_CMD}"))

# Serve the docs at <http://localhost:8000/> (default)
serve: ${DOCKERFILE}
	${DOCKER_BASE_CMD} serve --dev-addr=0.0.0.0:${PORT}

# Builds the docs
build: ${DOCKERFILE}
	${DOCKER_BASE_CMD} build

# Deploys the docs
gh-deploy: ${DOCKERFILE}
	${DOCKER_BASE_CMD} gh-deploy --force

# Print version
version: ${DOCKERFILE}
	${DOCKER_BASE_CMD} --version

# Print help
help: ${DOCKERFILE}
	${DOCKER_BASE_CMD} --help

# Builds the image and prints its hash
build-image: ${DOCKERFILE}
	echo $(shell ${DOCKER_BUILD_CMD})

# Download and update the BIB file
bib: clean-bib ${BIB_FILE}
${BIB_FILE}: download-bib fix-bib

# Download the BIB file
download-bib:
	curl "https://researchr.org/downloadbibtex/bibliography/${RESEARCHR}" -o ${BIB_FILE}

# Fix the BIB file
fix-bib:
	sed -i '' '1 s/^/% /' ${BIB_FILE}
	sed -i '' 's/doi = {http.*\/\(10\..*\)}/doi = {\1}/' ${BIB_FILE}
	sed -i '' '/doi = {http.*}/d' ${BIB_FILE}
	sed -i '' 's/\&uuml;/ü/' ${BIB_FILE}

# Remove the BIB file
clean-bib:
	rm -f ${BIB_FILE}

.PHONY: serve new build deploy help build-image bib download-bib fix-bib clean-bib
.SILENT: