Skip to content

docs: trim comments in the CI-auth workflows - #65

Merged
michieldegezelle merged 1 commit into
mainfrom
trim-workflow-comments
Oct 6, 2026
Merged

michieldegezelle merged 1 commit into
mainfrom
trim-workflow-comments

Conversation

@michieldegezelle

Copy link
Copy Markdown
Collaborator

Description

Comment-only clean-up of the shared CI-auth workflows, so the workflow structure is readable at a glance. Each file is byte-identical with comments stripped, so no behaviour changes for any caller.

What stays: the caller contract in each header, and short "why it's like this" notes (at most ~3 lines per job or step). What goes: review narrative, measurement history and essays about rejected alternatives. Those live in the commit history and the review learnings. A few comments that had gone stale are fixed along the way (cron references, "only called by be_market").

File Comment lines
run_tests_inline_auth.yml 356 → 142
repair_firm_auth.yml 105 → 45
push_to_review_firm.yml 66 → 21
refresh-config-json/action.yml 50 → 17

update_templates_production.yml: deletes an 86-line commented-out job at the end of the file.

Not touched: run_tests.yml and check_auth.yml (go once every market has switched), run_sampler.yml (next step).

Type of change

  • Bug fix
  • New feature
  • Breaking change

Checklist

  • README updated (if needed)
  • Version updated (if needed)
  • Documentation updated (if needed)

Test plan

  • Each file diffed against main with comment lines stripped: identical
  • actionlint: no new findings (the shellcheck notices predate this change)
  • Comment-accuracy review of every rewritten comment: 5 findings (2 wrong mechanisms, 1 dropped load-bearing warning, 2 overstatements), all fixed

🤖 Generated with Claude Code

@coderabbitai

coderabbitai Bot commented Oct 6, 2026

Copy link
Copy Markdown

Review in Change Stack →

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: 9700acaf-f6bd-44ba-b153-7846279c07f9
📥 Commits

Reviewing files that changed from the base of the PR and between a896208 and 1b675d8.

📒 Files selected for processing (5)
  • .github/actions/refresh-config-json/action.yml
  • .github/workflows/push_to_review_firm.yml
  • .github/workflows/repair_firm_auth.yml
  • .github/workflows/run_tests_inline_auth.yml
  • .github/workflows/update_templates_production.yml
 ______________________________________________
< Making your bugs an offer they can't refuse. >
 ----------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ

Note

Some coding-guideline sources were skipped; the reason is listed next to each one. Other guidelines were applied as usual. On a public repository, sources from your configuration are listed without their names.

Skipped guideline sources (1)
a configured source — invalid entry; expected repo:path or owner/repo:path with a relative file path
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Comment thread .github/workflows/run_tests_inline_auth.yml Outdated
Comment-only: each file is byte-identical with comments stripped. Keeps the
"why it's like this" and the caller contract; drops review narrative,
measurement history and rejected-alternative essays (those live in commit
history and the review learnings). Also fixes a few comments that had gone
stale (cron references, "only called by be_market").

- run_tests_inline_auth.yml: 356 -> 142 comment lines
- repair_firm_auth.yml: 105 -> 45
- push_to_review_firm.yml: 66 -> 21
- refresh-config-json/action.yml: 50 -> 17
- update_templates_production.yml: delete an 86-line commented-out job

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@michieldegezelle
michieldegezelle merged commit 5f2ce5c into main Oct 6, 2026
6 checks passed
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.

1 participant