Skip to content

Conversation

@ebembi-crdb
Copy link
Contributor

Summary

Adds a Docker-based build system to ensure consistent Jekyll documentation builds across all
developers and environments. This eliminates "works on my machine" issues by pinning all
dependencies.

  • Create Dockerfile with pinned versions (Ruby 3.4, Bundler 4.0, Jekyll 4.3.4, Python 3.13,
    Node.js 20)
  • Add Makefile targets for Docker-based local development
  • Add GCP Cloud Build configuration for multi-arch image publishing
  • Publish initial image to us-docker.pkg.dev/release-notes-automation-stag/docs-builder

Usage

make docker-build   # Build image locally (first time)
make docker-serve   # Serve docs at http://localhost:4000/docs/
make docker-pull    # Pull pre-built image from GCP

Test plan

- Build Docker image locally
- Run make docker-serve and verify site loads at localhost:4000
- Push image to GCP Artifact Registry
- Verify make docker-pull works

This adds a Docker-based build system for consistent Jekyll documentation
builds across all developers and environments.

Changes:
- Add Dockerfile with pinned versions (Ruby 3.4, Bundler 4.0, Jekyll 4.3.4)
- Add .dockerignore to exclude build artifacts
- Add ci/README.md with usage documentation and troubleshooting
- Add ci/cloudbuild.yaml for GCP Cloud Build multi-arch builds
- Update Makefile with docker-build, docker-serve, docker-shell targets
- Update Gemfile with Docker rebuild instructions
- Fix _plugins/versions/release_info.rb for Docker path compatibility

Image published to: us-docker.pkg.dev/release-notes-automation-stag/docs-builder/docs-builder:latest

Usage:
  make docker-build  # Build image locally
  make docker-serve  # Serve docs at http://localhost:4000/docs/
  make docker-pull   # Pull pre-built image from GCP
@ebembi-crdb ebembi-crdb requested a review from a team as a code owner December 10, 2025 14:09
@netlify
Copy link

netlify bot commented Dec 10, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit d0da472
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/6941985c2b164b0008904eb2

@netlify
Copy link

netlify bot commented Dec 10, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit d0da472
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/6941985c5a8d440008a9ddca

@github-actions
Copy link

github-actions bot commented Dec 10, 2025

Files changed:

  • .gitignore
  • src/current/.dockerignore
  • src/current/Dockerfile
  • src/current/Gemfile
  • src/current/Gemfile.lock
  • src/current/Makefile
  • src/current/_plugins/versions/release_info.rb
  • src/current/ci/README.md
  • src/current/ci/cloudbuild.yaml

@netlify
Copy link

netlify bot commented Dec 10, 2025

Netlify Preview

Name Link
🔨 Latest commit d0da472
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/6941985c546d1a000853357d
😎 Deploy Preview https://deploy-preview-21567--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

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