ノート: この機能を使用するには、サイト管理者がyour GitHub Enterprise Server instanceのcode scanningを有効にする必要があります。 詳しい情報については「アプライアンスのためのcode scanningの設定」を参照してください。
CIシステムでのCodeQL code scanningについて
Code scanning は、開発者が GitHub リポジトリ内のコードを分析して、セキュリティの脆弱性とコーディングエラーを見つけることができる機能です。 分析によって特定されたすべての問題はGitHub Enterprise Serverに表示されます。 For information, see "About code scanning with CodeQL."
CodeQL code scanningをGitHub Enterprise Server内で、GitHub Actionsを使って実行できます。 あるいは、サードーパーティの継続的インテグレーションあるいは継続的デリバリ/デプロイメント（CI/CD）システムを使っているなら、CodeQLの分析を既存のシステム上で実行し、その結果をyour GitHub Enterprise Server instanceにアップロードできます。
CodeQL CLIをサードパーティのシステムに追加して、コードを分析するツールを呼び、SARIFの結果をGitHub Enterprise Serverにアップロードしてください。 結果のcode scanningアラートは、GitHub Enterprise Server内で生成されたアラートとともに表示されます。 For more information, see "About CodeQL code scanning in your CI system."
ノート: GitHub Enterprise Serverでcode scanningの結果として表示するためにSARIFデータをアップロードすることは、GitHub Advanced Securityが有効化されたOrganizationが所有するリポジトリでサポートされています。 詳しい情報については「リポジトリのセキュリティ及び分析の設定の管理」を参照してください。
CodeQL CLI について
CodeQL CLIは、コードの分析に利用できるスタンドアローンの製品です。 その主な目的は、コードベースのデータベース表現であるCodeQLデータベースを生成することです。 データベースの準備ができれば、それに対してインタラクティブにクエリを実行したり、SARIFフォーマットで結果セットを生成するためのクエリのスイートを実行して、結果をyour GitHub Enterprise Server instanceにアップロードしたりできます。
以下の分析にはCodeQL CLIを使ってください:
- たとえばJavaScriptやPythonのような動的言語。
- たとえばC/C++、C#、Javaのようなコンパイル言語。
- 複数言語を組み合わせて書かれたコードベース。
詳しい情報については「CIシステムでのCodeQL CLIのインストール」を参照してください。
ノート:CodeQL CLIは、Advanced Securityライセンスを持つお客様にご利用いただけます。
CodeQL CLIがお使いのCIシステムでの利用に適していない場合は、代替としてCodeQLランナーが利用できます。 通常、これはCIシステムがコンパイラの呼び出しを調整するとともに、CodeQLの分析の実行もしなければならないような場合です。 詳しい情報については、「CodeQLランナー を CI システムで実行する」を参照してください。
Note: The CodeQLランナー is being deprecated. Please use the CodeQL CLI version 2.6.2 or greater instead. GitHub Enterprise Server 3.3 will be the final release series that supports the CodeQLランナー. On GitHub Enterprise Cloud, the CodeQLランナー will be supported until March 2022. For more information, see the CodeQL runner deprecation.