bestit/qa-daux-confluence repository overview

⁠bestit/qa-daux-confluence

Daux.io image for Confluence export with Mermaid pre-rendering (https://daux.io/⁠)

Built from a multi-arch PHP base with Node, Chromium and mermaid-cli so Confluence uploads can pre-render Mermaid diagrams. Runs natively on amd64 and arm64 (Apple Silicon), avoiding Chromium SSE3 errors under emulation.

⁠Usage

To generate HTML docs from the docs folder in your working directory:

docker run -v $PWD:/build --workdir /build --rm -it bestit/qa-daux-confluence:1.0.3 generate

To upload documentation to Confluence:

docker run -v $PWD:/build --workdir /build --rm -it bestit/qa-daux-confluence:1.0.3 generate --format=confluence

For Mermaid diagrams in Confluence Cloud, enable pre-rendering in your Daux config (for example docs/config.json):

{
    "confluence": {
        "pre_render_mermaid": true,
        "mermaid_cli_path": "mmdc",
        "mermaid_image_format": "svg"
    }
}

mmdc is wrapped to use the image Chromium with --no-sandbox, which is required inside Docker.

⁠Releasing new versions

The build is using a docker multi stage build. To release a new version the following steps are required:

1. Update tool_version (and mermaid_cli_version if needed) in Dockerfile (amd64) and Dockerfile.arm64v8 (arm64v8)
2. Update versions in multi-arch-manifest.yaml for both platforms.
3. Update CHANGLOG.md accordingly.
4. Push new tag, dockerhub will start the build automatically.

⁠Local Testing

To test the Dockerfiles locally you can execute this command to build the image on amd64 and arm64 architectures:

docker buildx build --force-rm --no-cache -t qa-daux-confluence --platform linux/arm64,linux/amd64 . && docker run -it qa-daux-confluence