Skip to content

ci: PR差分に対するtextlint検査を追加(差分lint方式) - #712

Closed
kumagoro1202 wants to merge 1 commit into
developfrom
ci/textlint-diff-lint
Closed

ci: PR差分に対するtextlint検査を追加(差分lint方式)#712
kumagoro1202 wants to merge 1 commit into
developfrom
ci/textlint-diff-lint

Conversation

@kumagoro1202

Copy link
Copy Markdown
Contributor

概要

プルリクエストで変更された ja 配下の rst ファイルのみを textlint で検査する GitHub Actions ワークフローを追加します。

方針: 差分lint方式

  • 既存の全ファイルを対象にすると既存の指摘が大量に出て運用できないため、変更ファイルのみを対象とします。
  • 目的は「新規・変更箇所からの誤字・表記ゆれの混入を水際で防止する」ことであり、既存違反の一括修正は行いません。
  • ファイル名は環境変数経由で渡し、スクリプトインジェクションを防止しています。

変更

  • .github/workflows/textlint.yml(新規)

補足

  • 実lint/フルSphinxビルドはローカルのPythonバージョン制約により未実施です。

プロジェクトには textlint + prh 辞書が整備済みだが CI で強制されて
おらず、ローカル手動運用のため誤字・表記ゆれの混入を防げていない。
本ワークフローは、プルリクエストで変更された ja 配下の rst ファイル
のみを対象に textlint を実行する「差分lint方式」を採用する。

- 既存の全ファイルを対象にすると既存指摘が大量に出て運用不能になる
  ため、変更ファイルのみを検査対象とする
- textlint-plugin-rst の依存(docutils-ast-writer)と npm 依存を
  インストールして実行する
- ファイル一覧はスクリプトインジェクション防止のため環境変数経由で
  受け渡す
@kumagoro1202

Copy link
Copy Markdown
Contributor Author

CIはGitHub上ではなく別途環境を立てているためGitHub Actionsは使わない。

@kumagoro1202
kumagoro1202 deleted the ci/textlint-diff-lint branch July 23, 2026 12:59
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