Skip to content

ci: unify workflow file names and titles across the org - #305

Merged
shenxianpeng merged 1 commit into
mainfrom
chore/unify-workflow-names
Oct 16, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
chore/unify-workflow-names

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Oct 16, 2026 •

Copy link
Copy Markdown
Member

Before: the tests ran in two workflows, Test and Coverage; the workflow that moves the v2 tag was release.yaml titled Release, though it publishes nothing; Commit Check and Release Drafter had no permissions: block.

After: one CI workflow (ci.yml) with the test and coverage jobs, Retag v2 (retag.yml), pre-commit, and explicit permissions everywhere, matching the other commit-check repositories.

How:

  • Job names are unchanged (test, coverage, re-tag), so required status checks are unaffected. No README badge referenced these files.
  • Release Drafter gets contents: write and pull-requests: write, the same grant the CLI repository gives it.
  • Dependabot: github-actions monthly and grouped; pip stays daily with no cooldown so a new commit-check release reaches the action at once. Subjects are chore(deps).
  • Old Probot .github/stale.yml removed; LICENSE holder written as in the other repositories.

Summary by CodeRabbit

  • Chores
    • Automated updates for GitHub Actions are now grouped and scheduled monthly; Python package updates remain daily.
    • Continuous integration now includes test coverage checks and reporting.
    • Updated repository workflow labels and permissions, and refreshed the license attribution.

- test.yml and coverage.yml merge into ci.yml (CI); the test and
  coverage job names are unchanged.
- release.yaml -> retag.yml (Retag v2): it moves the v2 tag, it does not
  publish anything. pre-commit.yml is titled pre-commit.
- Commit Check and Release Drafter get explicit permissions, like every
  other workflow.
- Dependabot: github-actions monthly and grouped; pip stays daily so a
  new commit-check release reaches the action at once.
- Drop the Probot stale config; LICENSE holder written the same way in
  every repository.
@coderabbitai

coderabbitai Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: eab32898-c05d-4c6b-947f-22f46fe2acf5
📥 Commits

Reviewing files that changed from the base of the PR and between bcbadb3 and 405daf7.

📒 Files selected for processing: 9
  • .github/dependabot.yml
  • .github/stale.yml
  • .github/workflows/ci.yml
  • .github/workflows/commit-check.yml
  • .github/workflows/coverage.yml
  • .github/workflows/pre-commit.yml
  • .github/workflows/release-drafter.yml
  • .github/workflows/retag.yml
  • LICENSE
💤 Files with no reviewable changes: 2
  • .github/stale.yml
  • .github/workflows/coverage.yml

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

Dependabot update settings changed. The CI workflow now includes coverage reporting, and the separate Coverage workflow was removed. Other workflow permissions and names changed. The stale configuration file was deleted, and the LICENSE attribution was updated.

Changes: Repository maintenance

Layer / File(s) Summary
Dependabot update settings
.github/dependabot.yml
GitHub Actions updates now run monthly and are grouped. Pip updates remain daily. Both update configurations use chore commit subjects with scope.
CI coverage workflow
.github/workflows/ci.yml, .github/workflows/coverage.yml
The workflow name changed to CI. It now includes a coverage job that runs tests and uploads coverage to Codecov. The separate Coverage workflow was removed.
Workflow permissions and names
.github/workflows/commit-check.yml, .github/workflows/release-drafter.yml, .github/workflows/pre-commit.yml, .github/workflows/retag.yml
The commit-check workflow declares contents: read. Release Drafter sets workflow-level permissions and grants write permissions to its job. The pre-commit and retag workflow names changed.
Repository configuration and attribution
.github/stale.yml, LICENSE
The stale configuration file was deleted. The LICENSE attribution changed to Xianpeng Shen; the year remains 2023.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~15 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 405da

The automation and metadata updates appear ready to merge after normal checks; no concrete blocking issue is established.

Pre-merge checks: Passed 5
Check name Status Explanation
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly describes the workflow renaming and title updates, which are central changes in the pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (7 skipped: 7 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@shenxianpeng
shenxianpeng requested a review from a team as a code owner October 16, 2026 18:05
@github-actions

Copy link
Copy Markdown
Contributor

Commit Check

✅ All 5 checks passed

Show all 5 checks
Commit message
  ✔ PR title (ci: unify workflow file names and titles across the org)
  ✔ Commit 1/1 (405daf7) (ci: unify workflow file names and titles across the org)
Branch
  ✔ Branch (chore/unify-workflow-names)
Author
  ✔ Author name (Xianpeng Shen)
  ✔ Author email (3353385+shenxianpeng@users.noreply.github.com)

commit-check 2.19.0 · Rules reference

@codecov

codecov Bot commented Oct 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (bcbadb3) to head (405daf7).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #305   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines          654       654           
=========================================
  Hits           654       654           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@shenxianpeng
shenxianpeng merged commit 3ab602c into main Oct 16, 2026
25 checks passed
@shenxianpeng
shenxianpeng deleted the chore/unify-workflow-names branch October 16, 2026 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant