Skip to content

Commit

Permalink
Adjust the component template docs preview command
Browse files Browse the repository at this point in the history
This commit:

This commit:
* Bumps Antora preview command docker image to vshn/antora-preview:3.0.0.1.
  This gives us a Antora preview which auto-refreshes the docs while the
  command is running and updates the image to one which contains the
  current VSHN Kroki instance URL.
* Only mounts `<component-dir>/docs` and `<component-dir>/.git` into the
  Docker container. This should avoid issues with Antora getting confused
  about paths in `vendor` not being readable in the container.
* Exposes port 35729 of the Docker container for the auto-reload browser
  plugin.

See also projectsyn/modulesync-control#59
  • Loading branch information
simu committed Feb 7, 2022
1 parent 33e61bc commit 7db7ca8
Showing 1 changed file with 2 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ YAMLLINT_DOCKER ?= $(DOCKER_CMD) $(DOCKER_ARGS) $(root_volume) $(YAMLLINT_IMAGE)
VALE_CMD ?= $(DOCKER_CMD) $(DOCKER_ARGS) $(root_volume) --volume "$${PWD}"/docs/modules:/pages docker.io/vshn/vale:2.1.1
VALE_ARGS ?= --minAlertLevel=error --config=/pages/ROOT/pages/.vale.ini /pages

ANTORA_PREVIEW_CMD ?= $(DOCKER_CMD) run --rm --publish 2020:2020 --volume "${PWD}":/antora docker.io/vshn/antora-preview:2.3.3 --style=syn --antora=docs
ANTORA_PREVIEW_CMD ?= $(DOCKER_CMD) run --rm --publish 35729:35729 --publish 2020:2020 --volume "${PWD}/.git":/antora/.git --volume "${PWD}/docs":/antora/docs docker.io/vshn/antora-preview:3.0.0.1 --style=syn --antora=docs


COMMODORE_CMD ?= $(DOCKER_CMD) $(DOCKER_ARGS) $(root_volume) docker.io/projectsyn/commodore:latest component compile . $(commodore_args)
JB_CMD ?= $(DOCKER_CMD) $(DOCKER_ARGS) --entrypoint /usr/local/bin/jb docker.io/projectsyn/commodore:latest install
Expand Down

0 comments on commit 7db7ca8

Please sign in to comment.