Skip to content

Promote: shared-workflow defect fixes - #37

Merged
scttbnsn merged 31 commits into
mainfrom
dev/repository-standards
Aug 21, 2026
Merged

Promote: shared-workflow defect fixes#37
scttbnsn merged 31 commits into
mainfrom
dev/repository-standards

Conversation

@scttbnsn

Copy link
Copy Markdown
Contributor

Promotes #36. Three defects in workflows other repos pin to.

The release: [published] trigger never fires. I wrote it into starchart-refresh.yml's doc comment this morning and told drydock and portwing to adopt it. GitHub suppresses workflow runs for events caused by GITHUB_TOKEN, which is what every consuming repo publishes releases with. A caller wired from this file's own example passes actionlint, passes zizmor, reads as correct, and refreshes nothing forever — the silent-success shape the committed-SVG rework existed to remove, reintroduced by the instructions for it. Now documents a workflow_dispatch the release cut fires, with the reason recorded so nobody re-derives the broken version.

An exact tag match was never the invariant. main-is-released.yml accepted any tag, so one named snapshot or latest on a drifted main read as a pass. Now requires a release-shaped version. Prerelease detection moved off case *-*, which called my-tag a prerelease.

A promotion merge reported drift for seconds, because the tag is pushed after the merge. Three attempts with a refetch between them; it cannot mask real drift, since an untagged main is still untagged on the last attempt.

Verified by extracting the decision block and running it against real repositories, not just by the contract tests — those assert strings, which is how the dead trigger passed fourteen of them this morning. Table is in #36. 87 tests green.

Both CodeRabbit findings on #36 were correct and fixed: the refetch warning described a state that might not hold, and "the two documented exceptions" was an overclaim, since pull_request is a third one that lands in an approval-required state.

Consuming repos re-pin after this promotes.

Adds organization-wide community health defaults, validation, ownership, contribution guidance, security policy, and hardened workflow checks.
* ci(workflows): add reusable CI foundation

* fix(workflows): harden reusable release contracts
* feat(quality): add normalized reporting foundation

* test(quality): run reporting contracts in standards validation

* fix(quality): align report validator with schema

* test(quality): verify GitHub integration outputs
* ci(profile): make asset generation read-only

* fix(profile): restrict asset validation egress
* ci(review): add deduplicated Greptile summon

* fix(review): serialize exact-head Greptile summons

* test(review): lock Greptile security controls
go-ci.yml's test and lint jobs ran unconditionally, so a Go-less repo
that only wants the language-agnostic workflow-security (zizmor) job
couldn't call it. Add run-test/run-lint boolean inputs, mirroring the
existing run-govulncheck/run-workflow-security/etc. toggle pattern,
defaulting to true so existing callers see no behavior change.

Fixes: #18
* ci(workflows): add module-directory input to node-ci

Mirrors go-ci's module-directory idiom: a string input defaulting to
"." threaded into each fixed script's env as MODULE_DIRECTORY, so a
repo with several independently-gated Node projects can call node-ci
once per project. The default preserves current behavior for existing
callers.

Extends the reusable CI contract test to assert the new input and its
threading, matching how run-test/run-lint were added for go-ci in #19.

* test(workflows): assert module-directory threads into all three node jobs
* docs(onboarding): align with the codified standards registry

- docs(onboarding): name Codecov as the coverage cloud; Qlty Cloud App and
  maintainability badge stay, checks stay non-required
- docs(onboarding): trivy deprecated in favor of Grype, including the qlty
  plugin blocks in the two reference configs (drydock#753, portwing#135)
- docs(onboarding): CodeRabbit free Pro is public-only; private repos use
  cross-account human review
- docs(onboarding): add the greptile.json contract and the label-gated
  second-opinion caller

* docs(onboarding): reword the CodeRabbit private-repo claim as org policy

- docs(onboarding): free-plan private-repo reviews exist but are
  rate-limited and never fired here; the skip is policy, not a plan fact
- docs(onboarding): pair the Greptile caller with auto-applied CodeRabbit
  labeling so the second-opinion label is criteria-driven
* chore(repo): meet our own onboarding checklist

- chore(repo): MIT LICENSE (infrastructure repos are MIT; products AGPL)
- docs(repo): root AGENTS.md with repo-specific rules and validation
- build(hooks): lefthook with commit-msg + pre-push mirroring CI via
  scripts/validate.sh

* fix(hooks): tighten the commit-msg exemptions and mirror zizmor's CI flags

- fix(hooks): merge/revert exemptions match git's generated subjects only,
  so a hand-typed 'Merge ...' subject no longer bypasses the check
- fix(hooks): require a non-whitespace character after the colon
- fix(hooks): zizmor runs --no-online-audits locally, matching CI's
  online-audits: false for local/CI parity

* fix(hooks): exempt only git-generated merge and revert subjects
* docs(community): add org-default code of conduct and community checklist items

CODE_OF_CONDUCT.md is Contributor Covenant 2.0 (drydock's tuned copy) with
the org contact security@codeswhat.com, cascading to every repo without a
local one. Onboarding checklist gains the cascade-first rule and the
Discussions on/off split for product vs meta repos.

* test(community): assert the code of conduct in the community-health contract
…32)

* feat(workflows): add the shared star-chart refresh reusable workflow

Replaces both retired star-chart engines org-wide. The chart becomes a
first-party SVG generated from GitHub's own stargazer timestamps and
committed into the consuming repository, so it needs no secret and makes
no request at render time.

That property is the point. A live route that loses its credential serves
a plausible placeholder at HTTP 200 forever with nothing reporting red,
which is exactly how drydock's chart sat broken. A committed artifact
fails visibly or not at all.

The generator is embedded in the workflow rather than checked out from a
second repository, so a caller's SHA pin covers every line of behaviour
with nothing resolved at run time. Verified against live data before
committing: byte-identical output to the reference implementation for
drydock at 238 stars and 3 API calls, and a clean no-op exit on a repo
with a single star.

- feat(workflows): starchart-refresh.yml, egress-blocked to api.github.com
  and github.com, contents: write as its only elevated scope
- test(workflows): contract test covering the embedded generator, env-var
  input handling, the self-contained SVG, and the conditional commit-back
- ci(validation): run the new contract test in standards validation
- docs(onboarding): document the caller shape and why the artifact is
  committed rather than served

* test(workflows): syntax-check the embedded star-chart generator

This workflow never runs in this repository, so a syntax error inside the
heredoc would first surface in a consumer's scheduled job, days later and
in someone else's lane.

The test recovers the generator the way the shell will actually see it,
stripping the run block's base indentation rather than reading the file
as written, since a heredoc body that looks correct in YAML can still
reach node malformed. Then node --check parses it.

Verified with a negative control rather than assumed: injecting a syntax
error into the generator fails the test, and reverting passes it.

* fix(workflows): reject the inputs that would publish a wrong star chart

All three from CodeRabbit on #32, and the max-pages one was a real bug of
exactly the kind this workflow exists to prevent.

max-pages: 0 made pages 0, which fetched nothing, which hit the "too few
stars" clean exit. A repository with 238 stars would have reported a
green no-op. A cap below the needed page count was worse than that: it
drew a chart from the first N pages and published a partial history as a
whole one behind a ::warning:: nobody reads. Both now fail loudly, and
the cap must be a positive integer.

branch had no runtime guard. Omitting a default only prevents omission,
so a caller could still pass main and, on a repository whose ruleset let
the push through, commit straight to the default branch. Rejected before
checkout rather than at the push, where the error would be confusing.

output-path was read through the environment, which stops script
injection but not traversal. An absolute or ../ path reached writeFileSync
outside the checkout, and the commit step then found nothing staged and
reported success. Writes now use the resolved and validated path rather
than the raw input, since a check that doesn't govern the write is
decoration.

Verified behaviourally, not by reading: each rejected input throws, the
one-star exit still no-ops, nothing lands outside the workspace, and the
happy path is still byte-identical to the reference output for drydock.
* ci(standards): assert main points at a release tag

Reusable workflow for the invariant behind "main is the released version,
not the newest work": every commit on main is a tagged release, so an
untagged main head is itself the alarm. Callers pin it by SHA and run it
on a schedule plus push to main.

It separates three states that all look like "not tagged" from the
outside. A repository with zero tags cannot be evaluated at all and says
so rather than reporting drift. A drifted main reports the newest
reachable tag and how many commits it is behind. A prerelease on main is
its own failure by default, since a release candidate on the default
branch is the exact drift this exists to catch.

Read-only: contents: read, egress blocked to github.com, and no
credentials persisted through checkout. fetch-depth: 0 because tags only
travel with full history and a shallow clone would fail for the wrong
reason and read as real drift.

* ci(starchart): render the codified chart shape in both themes

Scott drew the target and it is now the renderer. The chart reads as
native GitHub UI rather than as a third-party embed: a 900x460 card on
GitHub's own border colour, sans for the words and mono for every
number, a 2px accent line over a faint gradient, interior gridlines and
a solid baseline. The accent is the repository's logo colour, passed as
a new required input, and an accent that is not a colour now fails
instead of drawing a chart with no line.

Three behaviours the renderer decides rather than hard-codes, each
because the naive version produced something wrong on a real repository.
The y-axis searches step-and-tick-count pairs, since rounding the step
alone put drydock's 239 stars on a 0-400 axis with the curve in the
bottom 60% of the plot. The curve is a monotone cubic, since a cardinal
spline overshoots on a curve this flat and an overshoot on a cumulative
count draws a dip that never happened. X labels drop to day precision
when month names collide, which is the actual condition rather than a
guessed span threshold.

Two files ship now, not one. GitHub's theme toggle does not reach a
media query inside an <img>-embedded SVG, so a self-theming file shows a
white card to anyone reading GitHub dark with a light OS. It does drive
a <picture> element in the README, so the pair is generated from one
fetch and the markup chooses. They commit together or not at all: a
<picture> with a fresh light chart and a stale dark one shows two
different histories depending on who is looking, and nothing reports it.

The documented trigger moves from a cron to the release cut. A committed
artifact refreshed on a schedule mutates underneath a tag, which is what
the main-is-released rule forbids.

The renderer block is generated from ops render-chart.mjs by
splice-into-workflow.mjs rather than hand-copied, and byte parity with
that module was verified against live drydock data before this landed.
Also fixes an assertion in the main-is-released test that sliced the
whole if-block as the decisive expression and so could never pass.

* docs(onboarding): add the main-is-released caller to the section 4 checklist
* fix(workflows): close three shared-workflow defects

starchart-refresh: the documented `release: [published]` trigger never
fires. GitHub suppresses workflow runs for events caused by GITHUB_TOKEN,
and every consuming repo publishes its release with exactly that — portwing
via GoReleaser, drydock via `gh release create`. A caller wired from this
file's own example lints clean, reads as correctly configured, and refreshes
nothing forever. That's the silent-success shape the committed-SVG rework
existed to remove, reintroduced by the instructions for it. Example is now a
workflow_dispatch the release cut fires, with the suppression and its two
documented exceptions written down so the next person doesn't rederive the
broken version. Found by the sockguard lane after three repos had been told
to adopt it.

main-is-released: an exact tag match alone was never the invariant. Any tag
satisfied it, so one named `snapshot` or `latest` parked on a drifted main
read as a pass. Now requires a release-shaped version. Prerelease detection
moved off `case *-*`, which called `my-tag` a prerelease and would have
accepted it under allow-prerelease.

main-is-released: a promotion merges before its tag is pushed, so a run in
that window reported drift that resolved itself seconds later. Three
attempts with a tag refetch between them. It can't mask real drift — an
untagged main is still untagged on the last attempt — and a failed refetch
warns rather than passing.

Verified by extracting the decision block and running it against real
repositories: v1.7.4 and 1.7.4 pass, snapshot/latest/my-tag fail as
malformed, v1.7.0-rc.2 fails as prerelease and passes under
allow-prerelease, and allow-prerelease does not reopen the any-tag hole.
87 contract tests green.

* fix(workflows): correct two overstated claims CodeRabbit caught

The refetch warning said the verdict uses the refs from checkout. It might
not: attempt 1 can succeed and attempt 2 fail, and a failed fetch can leave
some refs updated. Now says the refs currently available on the runner,
which is what's actually true.

'The two documented exceptions to the suppression' was an overclaim.
pull_request with opened/synchronize/reopened is a third — it creates a run
in an approval-required state rather than being suppressed. workflow_dispatch
and repository_dispatch are the two that fire UNATTENDED, which is the
property a release cut actually needs, so the comment now says that instead.
@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@scttbnsn, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 54 minutes

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

Wait for the limit to reset, then comment @coderabbitai review or push new commits to the PR.

An organization admin can change what happens after included review limits in Billing.

How do review limits work?

CodeRabbit enforces per-developer PR review limits within each organization.

For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: ee180654-a829-4202-b9a6-c21eca33d55e

📥 Commits

Reviewing files that changed from the base of the PR and between a66a777 and 22d2706.

📒 Files selected for processing (4)
  • .github/tests/main_is_released_contract_test.py
  • .github/tests/starchart_refresh_contract_test.py
  • .github/workflows/main-is-released.yml
  • .github/workflows/starchart-refresh.yml

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@scttbnsn

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown
⚠️ Action not completed

Review rate limited.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@biggest-littlest biggest-littlest left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Promotion of the already-reviewed #36 diff. Required context green.

@ALARGECOMPANY ALARGECOMPANY left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved.

@scttbnsn

Copy link
Copy Markdown
Contributor Author

Merging without a CodeRabbit review on this PR, on purpose, and recording why so the green check isn't read as one.

CodeRabbit is rate-limited: "You've used all free OSS reviews for now," resets in 54 minutes. Its status check still went SUCCESS. That check is green because the review never started, not because it passed, which is the same shape as the dead release: trigger this PR exists to fix.

The content was reviewed. #37's file set is byte-identical to #36's, and CodeRabbit left 3 comments there. Both findings were real, both got fixed, both answered in-thread. Reviewing the same diff twice is what the rate limit is stopping, and it isn't buying anything.

@scttbnsn
scttbnsn merged commit 11004e4 into main Aug 21, 2026
4 checks passed
scttbnsn added a commit to CodesWhat/sockguard that referenced this pull request Aug 21, 2026
…320)

The shared repo promoted #36 to main (CodesWhat/.github#37). Trigger and
input surface are unchanged between the pins; the bump picks up the
main-is-released fixes (release-shaped tag required, prerelease
detection corrected, no drift report in the merge-to-tag window) and
the starchart doc comment that no longer recommends release: [published].
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.

3 participants