Move docs workflows to elastic/docs-actions#359
Conversation
Moves docs CI/CD from elastic/docs-builder to elastic/docs-actions. Part of elastic/docs-eng-team#474
📝 WalkthroughWalkthroughThe pull request refactors the documentation workflow infrastructure by replacing references from ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/workflows/docs-deploy.yml:
- Around line 3-16: The deploy job currently runs for any completed docs-build
workflow; add a success guard so deployments only run when the triggering
workflow completed successfully by adding an if condition on the deploy job
(jobs.deploy) that checks github.event.workflow_run.conclusion == 'success' (use
the GitHub Actions expression syntax) to prevent deploys after failed or
cancelled docs-build runs.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 6d1de326-12cd-4c5f-828c-4f6103b7e43e
📒 Files selected for processing (4)
.github/workflows/docs-build.yml.github/workflows/docs-cleanup.yml.github/workflows/docs-deploy.yml.github/workflows/docs-preview-cleanup.yml
💤 Files with no reviewable changes (1)
- .github/workflows/docs-cleanup.yml
2 participants
Summary
Moves our docs CI/CD workflow logic from
elastic/docs-buildertoelastic/docs-actions.elastic/docs-builderhas grown in scope;elastic/docs-actionslets thedocs team push updates to the
@v1tag independently without coupling tothe broader builder tooling.
The new setup follows GitHub's recommended two-phase workflow approach:
all required checks on pull requests now run with read-only access only.
Preview deployments and PR comments happen in a separate phase triggered
after the required check completes.
Replaces
preview-build.ymlanddocs-cleanup.ymlwith three new workflowfiles:
docs-build.yml,docs-deploy.yml, anddocs-preview-cleanup.yml.Preview deployments for forks:
Preview deployments are not available for fork PRs by default. If you are an
Elastic employee working from a fork, previews will work once your Elastic
GitHub organization membership is set to Public:
Go to https://github.com/orgs/elastic/people and find your name
Open the visibility dropdown next to your name and select Public
Or: GitHub profile -> Organizations -> Elastic logo -> set visibility
to Public.
Contributors outside Elastic will still get build validation feedback on
their PRs -- only preview deployments are skipped.
Post-merge
docs-buildinstead ofpreview-build(if applicable)cc @elastic/ingest-docs