Skip to content

[DOCS] Add ADR-005: Inline CI workflows for render-guides - #26

Open
linawolf wants to merge 1 commit into
mainfrom
task/adr-005-inline-ci-render-guides
Open

[DOCS] Add ADR-005: Inline CI workflows for render-guides#26
linawolf wants to merge 1 commit into
mainfrom
task/adr-005-inline-ci-render-guides

Conversation

@linawolf

Copy link
Copy Markdown
Member

render-guides#1196 proposed migrating the main.yaml workflow of
render-guides to the shared PHP workflows of this repository
(reusable-php-tests.yml, reusable-php-quality.yml,
reusable-php-command.yml). The pull request was closed on 2026-09-13.
This records why, so the question is answerable without digging through
a closed pull request.

The reason is amortisation: the three PHP workflows have no callers
today — the only mention of reusable-php-tests anywhere in the
organization is this repository's README.md. render-guides would be the
sole consumer, so "maintained in one place instead of once per
repository" has no second repository to amortise against.

Two costs would be incurred immediately for that absent benefit. The
actions in main.yaml are SHA-pinned and currently ahead of the shared
workflows (setup-php 2.37.2 versus 2.37.1, actions/cache v6.1.0 versus
v5.0.3), and adoption at @main would let a push here change the CI of
render-guides without review there. And six of the seven required status
checks would be renamed, with three checks that are gated today as steps
inside Quality needing explicit listing in the merge-queue ruleset from
ADR-004, or they stop gating silently.

The decision is explicitly reversible: it is revisited when a second PHP
repository adopts the shared PHP workflows, at which point render-guides
should follow rather than remain the exception.

render-guides#1196 proposed migrating the main.yaml workflow of
render-guides to the shared PHP workflows of this repository
(reusable-php-tests.yml, reusable-php-quality.yml,
reusable-php-command.yml). The pull request was closed on 2026-09-13.
This records why, so the question is answerable without digging through
a closed pull request.

The reason is amortisation: the three PHP workflows have no callers
today — the only mention of reusable-php-tests anywhere in the
organization is this repository's README.md. render-guides would be the
sole consumer, so "maintained in one place instead of once per
repository" has no second repository to amortise against.

Two costs would be incurred immediately for that absent benefit. The
actions in main.yaml are SHA-pinned and currently ahead of the shared
workflows (setup-php 2.37.2 versus 2.37.1, actions/cache v6.1.0 versus
v5.0.3), and adoption at @main would let a push here change the CI of
render-guides without review there. And six of the seven required status
checks would be renamed, with three checks that are gated today as steps
inside Quality needing explicit listing in the merge-queue ruleset from
ADR-004, or they stop gating silently.

The decision is explicitly reversible: it is revisited when a second PHP
repository adopts the shared PHP workflows, at which point render-guides
should follow rather than remain the exception.

Signed-off-by: lina.wolf
Assisted-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019EuSAzF5qw81NzPusWy2hC
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant