Skip to content

Docs and CI fixes for specialized images#14

Merged
bschwedler merged 10 commits into
mainfrom
docs-and-ci-fixes
May 15, 2026
Merged

Docs and CI fixes for specialized images#14
bschwedler merged 10 commits into
mainfrom
docs-and-ci-fixes

Conversation

@ianpittwood

@ianpittwood ianpittwood commented May 14, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Split the production CI into separate WAML and WGCW workflows, with WGCW builds cached in Artifact Registry.
  • Add logos and badges to the READMEs and align overall structure with the recently overhauled images-workbench docs.
  • Fill in missing sections in the specialized READMEs: Quick reference tables, Architectures sections, and Code of Conduct + License sections on the root README.
  • Fix factual errors in the per-image READMEs (TinyTeX path on WAML, Pro Drivers row on WGCW, broken GCW workflow badge, Latest Version badge link targets, GHCR Pulls badge URL).
  • Apply Posit style guide fixes flagged by doc-reviewer: sentence-case root title, complete-sentence colon intros, active voice rewrites of the IMPORTANT callout and the GCW mirror note.
  • Disable caching on pr.yml workflow builds.
  • Remove QEMU from workflows as it is unused.

Test plan

  • WAML workflow runs successfully against this branch
  • WGCW workflow runs successfully against this branch
  • All badges on the root, WAML, and WGCW READMEs render with correct values
  • Quick reference and Architectures sections render correctly on GitHub
  • Verify the Pro Drivers row on WGCW matches the image contents

🤖 Generated with Claude Code

ianpittwood and others added 8 commits May 13, 2026 16:26
Replace the unified production.yml with per-image waml.yml and wgcw.yml so
each image builds, tests, and pushes independently. WGCW retains the GCP
workload-identity auth and gcloud Artifact Registry configuration; WAML
omits them. Both filter the build matrix to a single image via
`bakery ci matrix <image-name>`.

Drop the `--cache-registry` argument and the post-build clean job, since
GHCR's image size cap is smaller than the build cache for these images
and the registry-backed cache cannot be relied on.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Point WGCW's build cache at us-central1-docker.pkg.dev/cloud-workstations-cache
since the Workbench image exceeds GHCR's per-image size cap. Retention rules
already exist on the registry, so no cleanup job is needed here.

Also add the Workbench logo, status/version badges, and an "intended use"
callout to the WAML README to bring it in line with other Posit image READMEs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The badge pointed to production.yml, which does not exist in this
repository. Point it to wgcw.yml instead.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- WAML: fix TinyTeX path (Quarto installs to /opt/.TinyTeX, not a build-time-only artifact).
- WAML: point Latest Version badge to the GHCR package page rather than the
  unrelated docker.io/posit/workbench tags page.
- WGCW: add the Pro Drivers row (the Containerfile installs rstudio-drivers).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Root: Code of Conduct + License sections linking CODE_OF_CONDUCT.md and LICENSE.md.
- WAML/WGCW: Quick reference table near the top, summarizing maintainer, support
  channels, source, license, and product docs.
- WAML/WGCW: Architectures section noting linux/amd64-only support.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Root: title uses sentence case; replace fragment-before-colon intros
  ("Additional documentation:", "Build prerequisites:") with complete
  sentences.
- WAML: rewrite the IMPORTANT callout in active voice; expand the
  "For example:" fragment to a complete sentence.
- WGCW: rewrite "A mirror is also available" in active voice; same
  fragment fix on the tag-examples intro.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Comment thread .github/workflows/waml.yml Dismissed
Comment thread .github/workflows/waml.yml Dismissed
@ianpittwood
ianpittwood marked this pull request as ready for review May 14, 2026 19:43
@ianpittwood
ianpittwood requested a review from bschwedler as a code owner May 14, 2026 19:43
@bschwedler
bschwedler merged commit b80b2dc into main May 15, 2026
8 checks passed
@bschwedler
bschwedler deleted the docs-and-ci-fixes branch May 15, 2026 10:17
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.

3 participants