Skip to content

ci: run site/mdoc on PRs that update site/ - #5992

Open
arimu1 wants to merge 1 commit into
spotify:mainfrom
arimu1:fix/4214-gha-mdoc-site
Open

ci: run site/mdoc on PRs that update site/#5992
arimu1 wants to merge 1 commit into
spotify:mainfrom
arimu1:fix/4214-gha-mdoc-site

Conversation

@arimu1

@arimu1 arimu1 commented Aug 8, 2026

Copy link
Copy Markdown

Description

Runs sbt site/mdoc on pull requests that touch the site/ directory so documentation snippet changes are validated in CI.

The existing Generate Site job already runs full site/makeSite for non-fork PRs, but is skipped for fork PRs (GCP credentials). This lightweight, path-filtered workflow fills that gap without requiring GCP.

Related issues

Fixes #4214

Notes

  • Follows the same pattern as .github/workflows/scalafix.yaml (hand-written, path-filtered; not part of generated ci.yml).
  • Uses site/mdoc as documented in CONTRIBUTING.md (root does not aggregate site).
  • No GCP auth needed for compile-only mdoc validation.

Add a path-filtered workflow so documentation changes are validated with
sbt site/mdoc, including on fork PRs where the full site job is skipped.

Fixes spotify#4214
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.

GHA should run sbt mdoc on pull requests that update site directory

1 participant