Repository navigation
ci: remove and correct stale comments in workflows and scripts - #186
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 35 minutes. View limit details
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 |
|
The latest Docker Doctor scan for this pull request. Learn more about Docker Doctor.
Score: 84 / 100 · 3 issues
Scanned by Docker Doctor for commit |
commit: |
react-doctor.yml still carried the vendor's scaffold: a banner, comments
that restate the triggers and the concurrency group, and a commented-out
`with:` block with setup advice. dependabot.yml said the action
references are SHA-pinned, but 29 of the 43 in .github/workflows pin a
tag. release.yml and action-tag.yml each restated `permissions: {}` in
prose.
sync-kit-spec.ts explained isJsonObject in words its name and the next function already say. rule-page-content.ts labeled its shared examples the same way.
- oxlint.config.ts and oxfmt.config.ts called the CLI test fixtures deliberately malformed. Most of them are valid projects, and only some are malformed. - release.yml explained `!cancelled()` with a kit push earlier in the job. The publish job has had no kit push since kit-push.yml took it over. - generate-rules-doc.ts pointed at a note in apps/web/lib/score.ts about regex named groups and an ES2017 target. That note explains why client components cannot import core's barrel, which has nothing to do with this script.
315acc7 to
f27677a
Compare
Description
The comment audit for the workflows, scripts and root configs. This PR removes comments that repeat the YAML or the code and corrects four that are wrong.
Three commits:
react-doctor.ymlloses the vendor scaffold (a banner, comments that restate its triggers and concurrency group, and a commented-outwith:block of setup advice).dependabot.ymlsaid the action references are SHA-pinned, but 29 of the 43uses:lines in.github/workflowspin a tag.release.ymlandaction-tag.ymleach restatedpermissions: {}in prose.oxlint.config.tsandoxfmt.config.tscalled every CLI fixture deliberately malformed. Most are valid projects, so the comment now says some are.release.ymlexplained!cancelled()with a kit push earlier in the job. The publish job has had none sincekit-push.ymltook it over.generate-rules-doc.tspointed at a note inapps/web/lib/score.tsabout regex named groups and an ES2017 target. That note is about client components and core's barrel import.Kept: the policy comments (the Action's two tag tiers, why
paths:is narrow, the read-only smoke token, the Changesets flow,fetch-depth: 0).Left alone on purpose:
action.ymlandscripts/render-github-action-comment.mjs. Any change to either cuts an Action release and movesv1, so their two stale comments wait for the next real change.kits/docker-doctor/spec.yaml, which would need a kit changeset and release.Related Issues
N/A. Found by a comment audit of the repository.
Checklist
Screenshots (if applicable)
N/A
Additional Notes
ultracite check, typecheck and the generated docs are clean.@docker-doctor/cli.