Skip to content

ci: .md のみ変更時は重い CI をスキップしつつ required check を維持#49

Merged
yk-lab merged 2 commits into
mainfrom
feat/markdown-only-typo-check
Jun 22, 2026
Merged

ci: .md のみ変更時は重い CI をスキップしつつ required check を維持#49
yk-lab merged 2 commits into
mainfrom
feat/markdown-only-typo-check

Conversation

@yk-lab

@yk-lab yk-lab commented Jun 22, 2026

Copy link
Copy Markdown
Owner

概要

.md ファイルのみの変更時に、重い CI / self-test をスキップしつつ、branch protection の required check は常に green になるよう bridge job パターンを導入する。

変更内容

.github/workflows/ci.yml

  • paths-ignore を廃止
  • dorny/paths-filter でコード変更の有無を判定
  • check job をコード変更がある場合のみ実行
  • check-gate job を追加(常に成功 → required check 用)

.github/workflows/self-test.yml

  • paths-ignore を廃止
  • matrix / skip-checksum job をコード変更がある場合のみ実行
  • self-test-gate job を追加(常に成功 → required check 用)

.github/workflows/docs.yml

  • .md 変更時のみ発火から、全 PR/push で発火 に変更
  • コードコメント・YAML・action.yml 等の typo も検出

動作イメージ

PR 内容 実行される job
コード変更あり CI check + check-gate, Self-test matrix + skip-checksum + self-test-gate, Docs typos
.md のみ CI changes + check-gate, Self-test changes + self-test-gate, Docs typos
コード変更で失敗 gate job も failure → required check ❌

branch protection 設定変更

required check を以下に変更してください:

  • CI / Typecheck / Lint / Test / Build (gate)
  • Self-test / Self-test (gate)
  • Docs / Typo check(任意)

参照

- Backlog の未対応から #8 を削除

- 既に解決した Issue セクションに #46 / #47 で追加
@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@yk-lab, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 41 minutes and 17 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8727fdf9-a126-4bc2-8cb4-b7ac281c2b08

📥 Commits

Reviewing files that changed from the base of the PR and between 42de469 and efca546.

⛔ Files ignored due to path filters (3)
  • .github/workflows/ci.yml is excluded by !**/*.yml
  • .github/workflows/docs.yml is excluded by !**/*.yml
  • .github/workflows/self-test.yml is excluded by !**/*.yml
📒 Files selected for processing (1)
  • TODO.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/markdown-only-typo-check

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 and usage tips.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 4 files

Re-trigger cubic

@yk-lab yk-lab force-pushed the feat/markdown-only-typo-check branch from 17798a2 to d3b1c3d Compare June 22, 2026 16:37
- ci.yml / self-test.yml: paths-ignore 廃止、bridge job パターン導入

- docs.yml: 全変更で typo check を実行(.md に限定しない)

- dorny/paths-filter で変更検出、常に成功する gate job を required check 用に追加
@yk-lab yk-lab force-pushed the feat/markdown-only-typo-check branch from d3b1c3d to efca546 Compare June 22, 2026 16:50
@yk-lab yk-lab changed the title ci: .md 更新時は typo check のみ実行 ci: .md のみ変更時は重い CI をスキップしつつ required check を維持 Jun 22, 2026
@yk-lab yk-lab merged commit 72349b8 into main Jun 22, 2026
19 checks passed
@yk-lab yk-lab deleted the feat/markdown-only-typo-check branch June 22, 2026 17:22
yk-lab added a commit that referenced this pull request Jun 22, 2026
## 概要

要求仕様書 NFR-5(可観測性)に対応。アクション完了時に `core.summary` で導入結果をジョブサマリに出力する。

## 変更内容

### `src/main.ts`
- 実行中にサマリ用の情報(バージョン、アセット、cache、checksum、パス)を収集
- アクション成功時に `core.summary` で表形式のサマリを記録
- トークンは `core.setSecret` でマスク済みのため、サマリに漏れない

### ワークフロー修正(#49 フォローアップ、レビュー指摘対応)
- `ci.yml` / `self-test.yml` の bridge job (`*-gate`) が `changes` job
の失敗・キャンセルを正しく検出するよう修正
- `self-test.yml` に `pull-requests: read` を追加(`dorny/paths-filter` 用)

## サマリに含まれる項目

| Item | 例 |
|---|---|
| Version | `3.51.1` |
| Asset | `task_linux_amd64.tar.gz` |
| Source | `go-task/task GitHub Releases` |
| Cache | `hit` / `miss` |
| Checksum | `verified (SHA256)` / `skipped` / `n/a` |
| Executable | `/runner/tool-cache/task/3.51.1/x64/task` |

## 注意点

- エラー発生時はこれまで通り `core.setFailed` で終了。サマリは成功時にのみ出力。
- `core.summary.write()` 自体の失敗は考慮していない(Actions API の失敗は極めて稀)。

## 検証

- `pnpm run all` ✅
- `actionlint` ✅
- `dist/index.js` が再ビルド済み(source branch には commit しない方針)

## 参照

- Closes #39
- 要求仕様書 NFR-5
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