Tech Docs - GitHub Pages Publisher
April 22, 2026 ยท View on GitHub
This repository packages the Government Digital Service's tech-docs-gem in a container, to make it simple to use when developing and publishing your technical documentation using the template-documentation-site.
Usage of this container will be documented on the template-documentation-site.
Developing
Build Container
make build
Previewing Test Site
make preview
Managing Software Versions
Base Image and Ruby
Note
Dependabot might try to update this to the latest ruby image, but doing so will fail the Container Structure Test
The base image is derived from tech-docs-gem's latest supported Ruby version, which can be found in their test matrix.
As of 21/04/2026, that version is 3.4.9.
Using 3.4.9, you can find the latest Alpine image by searching Docker Hub.
To obtain the SHA, you can run:
docker pull --platform linux/amd64 docker.io/ruby:3.4.9-alpine3.23
docker image inspect --format='{{ index .RepoDigests 0 }}' docker.io/ruby:3.4.9-alpine3.23
Gemfile and Gemfile.lock
Important
Dependabot is configured to maintain these, however this repository is just packaging govuk_tech_docs, so proceed with caution when reviewing and approving
When the Government Digital Service release a new version of govuk_tech_docs, update src/opt/publisher/Gemfile and run make copy-gemlock. This will build the image, and copy the generated Gemfile.lock out of the image.
Releasing
To create a new release, follow GitHub's guidance, opting to create a new tag in the process.