docs(skills): add Caveats column to subcommand table, expand internal/ layout (SO-40)#113
docs(skills): add Caveats column to subcommand table, expand internal/ layout (SO-40)#113castrojo wants to merge 2 commits into
Conversation
…/ layout SO-40: The SKILL.md subcommand table was missing a Caveats column per AC3. Changes: - Add 4th column 'Caveats' to all 19 subcommand table rows with: - GITHUB_TOKEN requirements (or explicit 'No GITHUB_TOKEN needed') - Anonymous OCI pull note for fetch-supply-chain (authn.Anonymous) - packages:read scope requirement for fetch-testhub - Fallback behaviour for cold-start CI - Per-image repo lists for fetch-builds-* variants - Weekly-update cadence and cache-skip behaviour for fetch-countme - Expand internal/ directory tree to list all actual packages: brewfile, builds, contributors, ghcli, quay, scorecard, supplychain (previously only listed countme/github/history/metrics/osanalytics/tap/tapanalytics/testhub) - Add fetch-contributors step to CI walkthrough (was previously missing) - Correct step numbers in CI walkthrough (was off by one after contributors step)
📝 WalkthroughWalkthroughUpdated Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
|
Warning Gemini is experiencing higher than usual traffic and was unable to create the review. Please try again in a few hours by commenting |
…n daily-build.yml Two factual errors found by QA review (SO-76): 1. github/ package was removed from internal/ tree when ghcli/ was added. Both packages exist and are in active use: - internal/ghcli/ wraps the gh CLI binary (exec.go) - internal/github/ is a REST API client (client.go, graphql.go) Restore github/ alongside ghcli/ in the layout tree. 2. fetch-contributors was incorrectly placed as step 7 in daily-build.yml walkthrough. It does NOT run in daily-build.yml — it runs in the separate .github/workflows/contributor-sync.yml workflow. Remove from daily-build.yml list; add clarifying note. Also correct fetch-releases position (step 6 → step 10, matching actual workflow order after fetch-supply-chain). Co-authored-by: docs-writer
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@skills/SKILL.md`:
- Line 51: Update the description for the `internal/github` entry to narrow its
scope to only GitHub traffic/clone-related functionality (e.g., "github/ #
GitHub traffic/clone data") and remove references to packages and Actions
collection; add or clarify that package and Actions data are handled by
`internal/testhub` and `internal/builds` respectively so the README accurately
reflects implementation boundaries.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| │ ├── countme/ # Universal Blue countme badge + CSV fetcher | ||
| │ ├── github/ # GitHub REST API client (traffic data) | ||
| │ ├── ghcli/ # gh CLI wrapper (reads GITHUB_TOKEN automatically) | ||
| │ ├── github/ # GitHub REST API client (traffic, packages, Actions data) |
There was a problem hiding this comment.
Correct internal/github scope to avoid misleading package boundaries.
Line 51 says internal/github handles traffic, packages, and Actions data, but current implementation evidence shows traffic-clone functionality there; packages/actions collection is handled by other packages (internal/testhub, internal/builds). Please narrow this description.
Suggested doc fix
-│ ├── github/ # GitHub REST API client (traffic, packages, Actions data)
+│ ├── github/ # GitHub REST API client (traffic endpoints)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| │ ├── github/ # GitHub REST API client (traffic, packages, Actions data) | |
| │ ├── github/ # GitHub REST API client (traffic endpoints) |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@skills/SKILL.md` at line 51, Update the description for the `internal/github`
entry to narrow its scope to only GitHub traffic/clone-related functionality
(e.g., "github/ # GitHub traffic/clone data") and remove references to packages
and Actions collection; add or clarify that package and Actions data are handled
by `internal/testhub` and `internal/builds` respectively so the README
accurately reflects implementation boundaries.
1 participant
Summary
Closes SO-40: Update
skills/SKILL.mdsubcommand table with full coverage.What changed
The subcommand table in the
## stats-go Subcommandssection ofskills/SKILL.mdalready had all 19 subcommands documented (the prior gap was fixed in commit 3030097). This PR adds the final AC3 requirement: a Caveats column with auth requirements and operational notes per subcommand.Changes
Subcommand table:
Caveatsto all 19 subcommand rowsfetch-supply-chain(usesauthn.Anonymous)packages: readscope requirement forfetch-testhubfetch-builds-*variantsfetch-countmeRepository layout (
internal/directory tree):brewfile,builds,contributors,ghcli,quay,scorecard,supplychaingithub/→ghcli/(actual package name)CI walkthrough:
fetch-contributorsstep (was omitted from the numbered list)Acceptance criteria
cmd/stats/main.go)