CI: Add Gerrit bypassable RTDv3 verify workflow#47
Closed
ModeSevenIndustrialSolutions wants to merge 1 commit into
Closed
CI: Add Gerrit bypassable RTDv3 verify workflow#47ModeSevenIndustrialSolutions wants to merge 1 commit into
ModeSevenIndustrialSolutions wants to merge 1 commit into
Conversation
Add an organization-level bypassable required workflow that verifies Read the Docs (RTDv3) documentation builds for Gerrit patchsets, using a dedicated bypassable service account so maintainers can override the result when necessary. The workflow is a thin dispatcher: it clears the prior vote, delegates the documentation build/verification to the centrally-managed reusable gerrit-compose-required-rtdv3-verify.yaml (v0.8.1) in lfreleng-actions' releng-reusable-workflows, then votes the aggregated conclusion back to Gerrit. Unlike the ONAP equivalent this omits any bespoke inline doc-rules logic, keeping all shared behaviour in the reusable. All action references are SHA-pinned to their latest releases and the workflow passes zizmor --persona=auditor with zero findings. Co-authored-by: Claude <noreply@anthropic.com> Signed-off-by: Matthew Watkins <mwatkins@linuxfoundation.org>
zxiiro
approved these changes
Jul 20, 2026
Member
|
We do not have any sort of RTD bypassable voter for RE repositories. This is a no-op type job. All RE repos must pass all tests (including any related to docs) to be mergable. |
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
Adds an organization-level bypassable required workflow that verifies
Read the Docs (RTDv3) documentation builds for Gerrit patchsets, voting
with a dedicated bypassable service account so maintainers can override
the result when necessary.
Part of the effort to modernise the Linux Foundation Gerrit CI and
standardise on the centrally-managed reusable workflows in
lfit/releng-reusable-workflows.Design
Thin dispatcher (
on: workflow_dispatch, invoked by the Gerrit → GitHubintegration):
service account.
gerrit-compose-required-rtdv3-verify.yaml@v0.8.1, forwarding the RTDAPI token.
Gerrit.
Unlike ONAP's equivalent, this deliberately omits the bespoke inline
doc-rules-composelogic — all shared behaviour stays in the reusable,per the goal of standardising on centrally-managed CI.
Notes / follow-ups
uses:references are SHA-pinned to their latest releases.zizmor --persona=auditorwith zero findings. Thesecrets-outside-envallow-list is provided by the companion config PR(CI: Add zizmor auditor configuration #45), which should merge first.
LFIT_GERRIT_SERVER,LFIT_GERRIT_KNOWN_HOSTS,LFIT_GERRIT_SSH_BYPASSABLE_USER/LFIT_GERRIT_SSH_BYPASSABLE_PRIVKEY, theRTD_TOKENsecret, and theshared reusable's
vars.GERRIT_URL. A repository Ruleset must mapthis workflow as a bypassable required check for the Gerrit-mirrored
docs repositories.
Validation
actionlint→ cleanyamllint→ cleanzizmor --persona=auditor --offline→ no findings