Skip to content

docs: promote Docusaurus docs in promote_unstable_docs workflow#9994

Merged
anakin87 merged 4 commits into
mainfrom
docs-promote-workflow
Oct 31, 2025
Merged

docs: promote Docusaurus docs in promote_unstable_docs workflow#9994
anakin87 merged 4 commits into
mainfrom
docs-promote-workflow

Conversation

@anakin87
Copy link
Copy Markdown
Member

@anakin87 anakin87 commented Oct 31, 2025

Related Issues

Part of https://github.com/deepset-ai/haystack-private/issues/188

Proposed Changes:

Use the script promote_unstable_docs_docusaurus.py (introduced in #9980) in promote_unstable_docs workflow.

The workflow runs when a tag like vX.Y.0 is pushed, to trigger the actual release.

With the additions in this PR, the workflow promotes unstable docs to stable and creates a PR with them.

How did you test it?

Hard to test it in a realistic scenario without releasing Haystack.
However, I tested it in a simplified way in 5824644 -> generated PR: #9995 (based on a previous branch with unstable docs)

Checklist

  • I have read the contributors guidelines and the code of conduct
  • I have updated the related issue with new insights and changes
  • I added unit tests and updated the docstrings
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I documented my code
  • I ran pre-commit hooks and fixed any issue

@vercel
Copy link
Copy Markdown

vercel Bot commented Oct 31, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
haystack-docs Ignored Ignored Preview Oct 31, 2025 1:33pm

@anakin87 anakin87 marked this pull request as ready for review October 31, 2025 12:21
@anakin87 anakin87 requested a review from a team as a code owner October 31, 2025 12:21
@anakin87 anakin87 requested review from dfokina and sjrl and removed request for a team October 31, 2025 12:21
Comment thread .github/workflows/promote_unstable_docs.yml Outdated
Copy link
Copy Markdown
Contributor

@dfokina dfokina left a comment

Choose a reason for hiding this comment

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

Only one clarifying comment, otherwise LGTM! 🚀

Co-authored-by: Daria Fokina <daria.fokina@deepset.ai>
@anakin87 anakin87 merged commit 3382356 into main Oct 31, 2025
11 checks passed
@anakin87 anakin87 deleted the docs-promote-workflow branch October 31, 2025 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants