feat(standards): repo-conformance check + get.resq.software install#23
Conversation
Add a reusable repo-standards.yml that validates template/standards
conformance: a detectable LICENSE, a non-stub README.md with a title,
and no unrendered {{PLACEHOLDER}} template tokens (threshold-based, so
docs that merely mention the syntax don't false-trip).
Wire it into required.yml so every consumer repo inherits it through the
existing `required` status check, and into required-gate.yml to dogfood
it on this repo. Warn-by-default (annotations only), matching the org's
audit->enforce pattern (harden-runner audit, rulesets evaluate); pass
`repo-standards-strict: true` to required.yml to turn violations into a
hard failure once a repo is clean.
Adopt the new get.resq.software install endpoint:
- profile/README.md: collapse the two-curl onboarding to a single
`curl -fsSL https://get.resq.software | sh` (install.sh performs both
the SHA256-verified binary install and the git-hook setup).
- README.template.md: add a "ResQ CLI" install block with the one-liner
plus an inspect-before-run variant.
- .github/workflows/README.md: document repo-standards.yml and the
strict toggle.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Warning Review limit reached
More reviews will be available in 4 minutes and 19 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more credits in the billing tab to continue. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Code Review
This pull request simplifies the ResQ CLI installation instructions in both README.template.md and profile/README.md by replacing a multi-step setup with a single-line installation command, while also providing a safer alternative that downloads the script for inspection before execution. The reviewer's feedback correctly points out that using a generic filename like install.sh in the multi-step instructions risks overwriting existing files, and suggests using a more specific filename like install-resq.sh instead.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
…rity, Support, Acknowledgements Make the per-repo README scaffold more complete and opinionated: - Demo: optional GIF/screenshot block with explicit dimensions (no CLS) and a live-demo link. - Prerequisites: runtime/version table pinned to what CI tests. - Security: coordinated-disclosure pointer to the org-inherited SECURITY.md — never file vulns as public issues. - Support: docs / SUPPORT.md / issue-chooser links. - Acknowledgements: optional attribution section. - Contributing: note that the single `required` status check (language CI + security scan + repo-standards) must stay green. - Table of Contents updated to match; all linked org files verified to exist (SECURITY.md, SUPPORT.md, CONTRIBUTING.md, LICENSE, banner). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Use `install-resq.sh` (not generic `install.sh`) for the inspect-before-run download so it can't clobber an existing ./install.sh in the user's cwd. Applied in README.template.md and profile/README.md (addresses gemini-code-assist review on #23). - Add a centered nav-links row (Documentation · Website · Quick Start · Report Bug · Request Feature) under the badges for a cleaner rendered hero. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Summary
Two complementary changes — improving the org README template and adding a
GitHub-native way to enforce template/standards conformance across all
resq-software/*repos.1. Enforce conformance —
repo-standards.ymlA new reusable workflow that validates a repo against the org baseline:
LICENSE/COPYINGfile (org standard: Apache-2.0)README.mdwith a top-level title{{PLACEHOLDER}}template tokens (threshold-based: ≥3distinct tokens, excluding the literal
{{PLACEHOLDER}}meta-example, sodocs that merely mention the syntax don't false-trip)
ResQ README Templatescaffold markerIt's wired into:
required.yml→ every consumer repo inherits it through the existingsingle
requiredstatus check gated by org rulesetdefault-branch-baseline(id 15191038). No consumer-repo change needed.required-gate.yml→ this repo dogfoods the check on its own PRs.Warn-by-default, matching the org's audit→enforce pattern (harden-runner
audit, rulesets evaluate). Violations surface as
::warningannotationswithout failing the build. Flip to hard enforcement per-repo with:
2.
get.resq.softwareinstall endpointprofile/README.md— collapse the two-curl onboarding into a singlecurl -fsSL https://get.resq.software | sh. Verified the served script(
install.sh) does both the SHA256-verifiedresqbinary install and thegit-hook setup, so the second curl is redundant.
README.template.md— add a "ResQ CLI" install block (one-liner +inspect-before-run variant).
.github/workflows/README.md— documentrepo-standards.ymland therepo-standards-stricttoggle.Conformance audit (what warn-mode will surface, current public repos)
repo-standardschecks for a LICENSE file (more lenient than GitHub's SPDXdetector), so
NOASSERTIONrepos pass;NONErepos are the real gaps.Test plan
actionlintclean onrepo-standards.yml,required.yml,required-gate.yml(incl. shellcheck onrun:blocks)README.template.md→ 32 distinct tokens (would flag);README.md→ 0 (won't)required-gate(repo-standards runs in warn mode)required.yml@mainrun shows therepo-standardsjobNotes
required.ymlgains one optional input(
repo-standards-strict, defaultfalse); existing callers are unaffected.template/repo-conformance layer, not language CI).