ci: trigger docs quickstart tests on release tags - #2585
Draft
JakeSCahill wants to merge 1 commit into
Draft
Conversation
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
Proposal from the docs team: on
v*release tags, also send atrigger-testsrepository dispatch toredpanda-data/docswith the tag asconsole_version.Why
The docs repo runs a Doc Detective quickstart test that drives the Console UI end to end (login, topics, filters, user creation, screenshots for the docs). When a Console release changes the UI, documented procedures and screenshots can silently break. The most recent example: a UI rework changed the topic detail tabs and the create-user dialog, which broke the docs test in a way that only surfaced through the docs repo's nightly run, and the published screenshots drifted out of date for months (fixed in redpanda-data/docs#1846).
With this dispatch, the docs repo tests the new Console version at release time and files an issue in the docs repo when documented flows or screenshots break. The receiving side already supports this: redpanda-data/docs#1848 maps the
console_versionpayload to the test's version override.Open question for the Console team (why this PR is a draft)
At tag-push time, is the release image for the new tag already published to
docker.redpanda.com/redpandadata/console? If images publish later in the release pipeline (for example in console-enterprise), this dispatch would race image availability, and the right place for it is at the end of that pipeline instead. Happy to move it — the payload contract stays the same.No new secrets: uses the same
actions_bot_tokenand dispatch action as the existing steps in this workflow.🤖 Generated with Claude Code