ci: Include docs and /storybook site (github.io) step in Github release workflow#2818
Draft
awahab07 wants to merge 8 commits intoelastic:mainfrom
Draft
ci: Include docs and /storybook site (github.io) step in Github release workflow#2818awahab07 wants to merge 8 commits intoelastic:mainfrom
/storybook site (github.io) step in Github release workflow#2818awahab07 wants to merge 8 commits intoelastic:mainfrom
Conversation
… release workflow to release docs and Storybook github.io site.
Collaborator
Author
|
buildkite test this |
nickofthyme
reviewed
Apr 15, 2026
Collaborator
There was a problem hiding this comment.
The legacy Buildkite Deploy - GitHub Pages step is no longer the authoritative stable-site publisher, which prevents main-branch pushes from overwriting the release-driven public site.
I'm not sure this is the best approach. What about for changes to the docs alone where there is no fix or feature, that requires to run a release?
I can see pros and cons to both but I think having this on main that represents the current code is best.
@markov00 WDYT?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses the missing GitHub Pages publish step in the release workflow that left the hosted docs and Storybook stale after releases.
The hosted Elastic Charts docs and Storybook are now published as part of the release workflow so the public site stays aligned with released versions.
Details
This change moves stable GitHub Pages publishing into the manual release workflow instead of relying on the old main-branch Buildkite publish path.
It adds manual release inputs for dry runs and smoke-branch Pages testing, builds a release-ready static site artifact during the workflow, and publishes that assembled output to the configured Pages branch.
The docs and Storybook build logic is now shared through reusable TypeScript helpers under
.buildkite/utils/site.ts, while.buildkite/scripts/build_release_site.tsremains the runnable entrypoint used by the GitHub release workflow.The legacy Buildkite
Deploy - GitHub Pagesstep is no longer the authoritative stable-site publisher, which prevents main-branch pushes from overwriting the release-driven public site.How to test
yarn --cwd .buildkite build:release-site..release-site/index.htmland.release-site/storybook/index.htmlexist.Publish a Releasewithdry_run=true,publish_pages=false, andpages_target_branch=gh-pages.release-siteartifact and verify the assembled docs and Storybook output.dry_run=true,publish_pages=true, andpages_target_branch=gh-pages-smoke.gh-pages-smokebranch contents.main.mainwithdry_run=false,publish_pages=true, andpages_target_branch=gh-pages.