Repository navigation
chore: open-source readiness — devkit v2.1.6, CoC, usage docs - #27
Merged
Merged
Conversation
Devkit bumped to v2.1.6, which brings the hardened caller (DEC-081): the reusable workflow ref is pinned to a release tag instead of @main, and secrets are passed explicitly instead of secrets: inherit. @main meant every merge to the devkit went live here immediately and unreviewed, and inherit forwarded every repo- and org-level secret to it. Neither is needed: the workflow declares exactly three secrets, all optional. CODE_OF_CONDUCT.md (Contributor Covenant) — the last missing governance file. README gains a Usage section written from the behaviours the BDD suite actually asserts, cross-linked to docs/BEHAVIOUR.md so a reader can see each one as a screenshot from a passing run. No claims that CI does not prove. Existing repo-specific issue templates are deliberately left alone — they are tailored to this plugin and better than the generic ones.
omar-nahhas
marked this pull request as ready for review
August 5, 2026 09:30
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.
DiffVisualizer is ready to open-source. Any ```diff block in a chat becomes a side-by-side visual diff, with a fullscreen review overlay and raw-text copy.
All 10 BDD scenarios are illustrated in
docs/BEHAVIOUR.mdwith screenshots from a passing run — including the two that matter most for trust: malformed diff text falls back to a readable code block, and a non-diff fence is left completely untouched.What this PR contains
The security change is the substantive one
The caller previously used
@mainwithsecrets: inherit. That reached 24 repos, not four — includingagent-zero-new-plugin-template, so every future plugin inherited it.@mainis not merely "mutable": it meant every merge to the devkit went live in this repo's CI immediately and unreviewed. Three fleet-wide regressions already arrived that way — 18 sync PRs auto-closed (four already green), every consumer's e2e green while shipping zero traces, and every Dependabot PR structurally red.secrets: inheritforwarded every repo- and org-level secret, including ones added later and ones the workflow never declares. The reusable workflow declares exactly three, all optional — so the explicit list is a strict superset of what it consumes and breaks nothing.Rated honestly: confidentiality low (one org member, zero forks, no outside collaborators), integrity/blast-radius medium. Fixed as change management, not as a breach.
Documentation is generated, not written
docs/BEHAVIOUR.mdanddocs/screenshots/are produced bymake docsfrom this repo's own passing e2e run. Every screenshot is the asserted end state of a scenario that currently passes, so it cannot depict behaviour the plugin no longer has — and a renamed or deleted scenario drops out on regeneration. Captions are the BDD scenario titles verbatim.The new README Usage section links to it, so a reader can check every claim against a screenshot CI produced.
Open-source readiness
Why this is a draft
Yours to review, not mine to merge. Two things worth your eye:
enforce_admins: falseon this repo. I have been merging pastBLOCKEDwith--adminall session. The e2e was genuinely green each time, but if "CI green" is your gate for going public, branch protection is not currently enforcing it — I am, by choice. Worth tightening before you rely on it.