GitHub コード品質:リポジトリ有効化 API の公開
GitHub は、リポジトリごとにコード品質機能をプログラムで自動設定・管理できる新 API を公開し、CI/CD パイプラインへの統合を強化しました。
キーポイント
自動化可能な新 API の登場
PATCH および GET エンドポイントが追加され、コード品質のオンオフ切り替えや言語設定をプログラムで実行できるようになりました。
多様な言語とランナー対応
C#, Go, Java/Kotlin, JavaScript/TypeScript, Python, Ruby の主要言語に対応し、分析用ランナーの種類も指定可能です。
設定状態の可視化機能
既存のリポジトリの設定状態、言語構成、ランナータイプ、分析スケジュールを API を経由で取得できる機能が実装されました。
影響分析・編集コメントを表示
影響分析
この機能は、コード品質管理を静的な設定から動的な自動化プロセスへと転換させる重要なステップです。開発チームは CI/CD パイプラインの一部として品質ルールを一括適用できるようになるため、コンプライアンス遵守やセキュリティ基準の維持が効率化されます。ただし、オンプレミス環境(Enterprise Server)での利用不可という制約は、大規模組織への即時導入には注意が必要です。
編集コメント
手動設定の煩雑さを解消し、コード品質管理をインフラ自動化の一部として統合できる点は実務上非常に価値が高いです。ただし、Enterprise Server ユーザーは当面の間、この機能を利用できない点に留意する必要があります。
新しい Repository Enablement API を利用することで、個々のリポジトリに対して GitHub Code Quality のプログラムによる有効化と設定が可能になりました。この機能は本日、パブリックプレビューとして公開されています。
2 つの新しいエンドポイントが利用可能になりました:
PATCH /repos/{owner}/{repo}/code-quality/setup: リポジトリに対する Code Quality のデフォルトセットアップの有効化・無効化、解析対象言語の設定、ランナータイプの指定を行います。
GET /repos/{owner}/{repo}/code-quality/setup: リポジトリの現在の Code Quality 設定(ステータス、言語、ランナータイプ、分析スケジュールを含む)を取得します。
対応している言語には、csharp, go, java-kotlin, javascript-typescript, python, ruby が含まれます。
この機能は github.com のパブリックプレビューで利用可能ですが、Enterprise Server では利用できません。
GitHub Code Quality について詳しく知りたい場合は、コード品質に関するドキュメントをご覧ください。
「GitHub Code Quality: Repository Enablement API」という投稿は、The GitHub Blog で最初に公開されました。
原文を表示
You can now programmatically enable and configure GitHub Code Quality on individual repositories using the new Repository Enablement API, available today in public preview.
Two new endpoints are now available:
PATCH /repos/{owner}/{repo}/code-quality/setup: Enable or disable Code Quality default setup for a repository, configure the languages to analyze, and specify the runner type.
GET /repos/{owner}/{repo}/code-quality/setup: Retrieve the current Code Quality configuration for a repository, including state, languages, runner type, and analysis schedule.
Supported languages include csharp, go, java-kotlin, javascript-typescript, python, and ruby.
This feature is available in public preview on github.com and is not available on Enterprise Server.
To learn more about GitHub Code Quality, check out the documentation for code quality.
The post GitHub Code Quality: Repository Enablement API appeared first on The GitHub Blog.
関連記事
今日のまとめ
AI日報で今日の重要ニュースをまとめ読み