Skip to content

ci: Release orchestration workflow - #10233

Merged
anakin87 merged 8 commits into
mainfrom
release-orchestration-workflow
Dec 12, 2025
Merged

anakin87 merged 8 commits into
mainfrom
release-orchestration-workflow

Conversation

@anakin87

@anakin87 anakin87 commented Dec 12, 2025 •

Copy link
Copy Markdown
Member

Related Issues

Proposed Changes:

Add a release orchestration workflow. This acts as a higher level API over the current manual release process.
It is meant to be invoked using gh workflow run release.yml -R deepset-ai/haystack -f version=v2.99.0-rc1.

  • parses and validates the version
  • in case of first minor release candidate (2.99.0-rc1), calls the branch_off workflow which creates the v2.99.x release branch
  • creates and pushes the release tag: this triggers PyPI, Docker and Github releases
  • checks the published artifacts
  • sends a clear event to Datadog (I have set up a DD monitor connected to Slack)

How did you test it?

Extensively tested on my fork.
In any case, I'd like to test this firsthand in the first automated release (something might be off with GitHub tokens permissions).

Notes for the reviewer

In the end, I decided to create another script to prepare the release notification, to avoid overcomplicating the main workflow.

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have 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 have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

@vercel

vercel Bot commented Dec 12, 2025 •

Copy link
Copy Markdown
Contributor

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 Dec 12, 2025 2:08pm

@anakin87
anakin87 marked this pull request as ready for review December 12, 2025 10:50
@anakin87
anakin87 requested a review from a team as a code owner December 12, 2025 10:50
@anakin87
anakin87 requested review from mpangrazzi and vblagoje and removed request for a team and vblagoje December 12, 2025 10:50
@anakin87 anakin87 self-assigned this Dec 12, 2025
@github-actions github-actions Bot added the topic:DX Developer Experience label Dec 12, 2025

@mpangrazzi mpangrazzi 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.

Looks good! I think it could be also nice to add:

concurrency:
  group: release
  cancel-in-progress: false

to release.yml.

This will prevent two release workflows to run concurrently, which may happen accidentally. With this, the second one will be always queued.

Ref: https://docs.github.com/en/actions/how-tos/write-workflows/choose-when-workflows-run/control-workflow-concurrency

@anakin87

Copy link
Copy Markdown
Member Author

Looks good! I think it could be also nice to add:

concurrency:
  group: release
  cancel-in-progress: false

to release.yml.

This will prevent two release workflows to run concurrently, which may happen accidentally. With this, the second one will be always queued.

Ref: https://docs.github.com/en/actions/how-tos/write-workflows/choose-when-workflows-run/control-workflow-concurrency

Good idea! Added in 9af422b

@anakin87
anakin87 requested a review from mpangrazzi December 12, 2025 14:31

@mpangrazzi mpangrazzi 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.

👍

@anakin87
anakin87 merged commit 3b4f4ac into main Dec 12, 2025
11 checks passed
@anakin87
anakin87 deleted the release-orchestration-workflow branch December 12, 2025 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

topic:CI topic:DX Developer Experience

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: automate tagging & publishing of release‑candidate builds feat: Automate release‑candidate version bump & release‑note guard

2 participants