Skip to content

Route release Pages deploys through documentation workflow#41

Merged
eric-tramel merged 1 commit intomainfrom
codex/single-pages-deployer
May 8, 2026
Merged

Route release Pages deploys through documentation workflow#41
eric-tramel merged 1 commit intomainfrom
codex/single-pages-deployer

Conversation

@eric-tramel
Copy link
Copy Markdown
Contributor

What

Move GitHub Pages deployment ownership out of the release publish workflow. The Publish workflow now builds, checks, uploads release artifacts, updates ddp-package-assets/packages.json, and dispatches the Documentation workflow on main.

Why

Release-triggered Pages deploys could race or overwrite the main docs deployment state, which made the Simple API index feel like it needed a second manual Pages deployment. Keeping Pages deployment in one workflow makes the release path smoother and keeps docs, catalog JSON, and the package index deployed together.

Usage

The maintainer release flow stays the same:

gh release create data-designer-my-plugin/v0.2.0 \
  --title "data-designer-my-plugin v0.2.0" \
  --notes "Release data-designer-my-plugin v0.2.0" \
  --latest=false

After Publish updates ddp-package-assets/packages.json, it runs:

gh workflow run docs.yml --ref main

The Documentation workflow downloads the package metadata and deploys the full Pages site.

How

  • Drop pages: write, id-token: write, and the github-pages environment from Publish.
  • Add actions: write so Publish can dispatch docs.yml on main.
  • Remove direct configure-pages, docs build, Pages artifact upload, and deploy steps from Publish.
  • Update release/workflow docs to describe Documentation as the single Pages deployer.

Validation

  • ruby -e 'require "yaml"; YAML.load_file(".github/workflows/publish.yml"); YAML.load_file(".github/workflows/docs.yml"); puts "workflow yaml parsed"'
  • gh workflow view docs.yml
  • make docs
  • make check
  • git diff --check

@eric-tramel eric-tramel requested a review from a team as a code owner May 8, 2026 19:14
@eric-tramel eric-tramel merged commit 987f073 into main May 8, 2026
6 checks passed
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.

2 participants