Skip to content

Extract GitHub Pages deploy into standalone docs workflow - #4107

Closed
Mpdreamz wants to merge 1 commit into
mainfrom
feat/docs-github-pages-workflow
Closed

Mpdreamz wants to merge 1 commit into
mainfrom
feat/docs-github-pages-workflow

Conversation

@Mpdreamz

Copy link
Copy Markdown
Member

Separates the GitHub Pages deploy from the container build pipeline. Pages now updates on every main push independently, and PRs get a docs build check to catch broken content before merge.

Affects: Automation, Documentation

Prompt summary: The Pages deploy lived inside `prerelease.yml` behind `needs: [build]`, so documentation only updated when the full container build pipeline succeeded. The user wanted a standalone workflow that publishes on main push and also validates docs on PRs.

Why

The `deploy` job in `prerelease.yml` depended on `build` (container publish + attestation). If the container build failed for any reason, GitHub Pages stayed stale. The deploy also silently skipped on PRs, so broken docs only surfaced after merge.

What

New `docs.yml` workflow

Triggers on `push` to `main` and `pull_request`. A single `build` job runs `elastic/docs-builder@main` and uploads the pages artifact; a `deploy` job (main only) deploys it with `actions/deploy-pages`. PRs get the build check without the deploy. The concurrency group prevents concurrent Pages deploys while allowing PR builds to cancel each other.

`prerelease.yml` cleaned up

The `deploy` job is removed. `notify-failure` now only watches `build`. The container build and attestation pipeline is unchanged.

Pages now deploys on every main push independently of the container
build. PRs get a docs build check using the same job. Removes the
deploy job from prerelease.yml so it no longer blocks on containers.

Co-Authored-By: Claude <noreply@anthropic.com>
@Mpdreamz
Mpdreamz requested a review from a team as a code owner September 16, 2026 07:45
@Mpdreamz Mpdreamz added the automation packaging, ci/cd. label Sep 16, 2026
@Mpdreamz
Mpdreamz requested a review from akira28 September 16, 2026 07:45
@Mpdreamz Mpdreamz added the automation packaging, ci/cd. label Sep 16, 2026
@Mpdreamz

Copy link
Copy Markdown
Member Author

Misfiled — this workflow belongs in the docs-playground-release-notes-tagged repo, not docs-builder.

@Mpdreamz Mpdreamz closed this Sep 16, 2026
@Mpdreamz
Mpdreamz deleted the feat/docs-github-pages-workflow branch September 16, 2026 07:48

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved.


What is this? | From workflow: PR Review

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation packaging, ci/cd.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant