docs(reusable-workflows): fix CI gaps upstream in the shared workflow, not per-project#82
Merged
Merged
Conversation
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds a new section to the reusable workflow pitfalls documentation, advising developers to fix bugs and gaps upstream in the shared workflow rather than applying per-project patches. The reviewer suggested formatting a reference to another markdown file as a clickable markdown link instead of plain text backticks to improve navigation.
A /retro session on 2026-05-31 (session 743f82e8) surfaced a standing user preference stated during TYPO3 extension work: 'DRY — we use re-usable workflows so all our projects gain from improvements', with the instruction to check the shared typo3-ci reusable-workflow repo before patching a project. Adds pitfall #6 to reusable-workflow-pitfalls.md: when a CI/quality gap surfaces in a consumer, fix it in the shared reusable-workflow repo so every consumer inherits it, rather than patching the single project. Distinct from the existing pitfalls (#1-#5 cover how to author/reference; this covers where a fix belongs) and from reusable-workflow-security.md (SHA pinning). Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
CybotTM
force-pushed
the
feat/retro-fix-ci-gaps-upstream
branch
from
bfd574e to
8ace948
Compare
|
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
1 participant
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 pitfall #6 to
references/reusable-workflow-pitfalls.md: when a CI/quality gap surfaces in a consumer of a shared reusable workflow, fix it upstream in the shared workflow repo so every consumer inherits the fix — don't patch the single project's.github/workflows/.Came from
/retrosession on 2026-05-31 (session743f82e8).Finding: a standing user preference, stated verbatim during TYPO3 extension work — "DRY — we use re-usable workflows so all our projects gain from improvements" — together with the instruction to check the shared
typo3-cireusable-workflow repo before adding a per-project guard. Existing references cover how to reference/pin/secure reusable workflows but not where a fix belongs.Change
New section #6 (principle, not a structural trap): per-project patches reintroduce the duplication the shared workflow removes, drift out of sync, and force rediscovery in the next repo. Check whether the shared repo owns the concern; if so, land the fix there and let consumers pick it up via
@main/@vX.Y.Z. Explicitly contrasted with pitfalls #1–#5 and withreusable-workflow-security.md.Test plan
markdownlint-cli2clean (verified locally: 0 errors)reusable-workflow-security.mdresolve