ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

CIシステムでのCodeQL Code scanningについて

CodeQLを使い、サードパーティの継続的インテグレーションシステムでコードを分析し、結果をyour GitHub Enterprise Server instanceにアップロードできます。 結果のcode scanningアラートは、GitHub Enterprise Server内で生成されたアラートとともに表示されます。

Code scanning is available for organization-owned repositories where GitHub Advanced Security is enabled. 詳しい情報については、「GitHub Advanced Security について」を参照してください。

ノート: この機能を使用するには、サイト管理者が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もしくはCodeQLランナーをサードパーティのシステムに追加して、コードを分析するツールを呼び、SARIFの結果をGitHub Enterprise Serverにアップロードしてください。 結果のcode scanningアラートは、GitHub Enterprise Server内で生成されたアラートとともに表示されます。

ノート: GitHub Enterprise Serverでcode scanningの結果として表示するためにSARIFデータをアップロードすることは、GitHub Advanced Securityが有効化されたOrganizationが所有するリポジトリでサポートされています。 詳しい情報については「リポジトリのセキュリティ及び分析の設定の管理」を参照してください。

CodeQL CLIとCodeQLランナーの比較

CodeQL CLIは、コードの分析に利用できるスタンドアローンの製品です。 その主な目的は、コードベースのデータベース表現であるCodeQLデータベースを生成することです。 データベースの準備ができれば、それに対してインタラクティブにクエリを実行したり、SARIFフォーマットで結果セットを生成するためのクエリのスイートを実行して、結果をyour GitHub Enterprise Server instanceにアップロードしたりできます。

CodeQLランナーは、CodeQL CLIを使ってコードを分析し、結果をGitHub Enterprise Serverにアップロードするコマンドラインツールです。 このツールは、アクションを使ってGitHub Enterprise Server内でネイティブに実行される分析を模倣します。 このランナーは、CLIよりももっと複雑なビルド環境に統合できますが、そのために難しくなっており、セットアップでエラーが起こりやすくなっています。 また、問題をデバッグするのもさらに難しくなっています。 概して、あなたのユースケースがサポートされていないのでないかぎり、CodeQL CLIを直接使う方がいいでしょう。

以下の分析にはCodeQL CLIを使ってください:

  • たとえばJavaScriptやPythonのような動的言語。
  • 単一のコマンドで、あるいは単一のスクリプトを実行することでビルドできるコンパイル言語でのコードベース。

詳しい情報については「CIシステムでのCodeQL CLIのインストール」を参照してください。

以下が必要な場合は、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.

詳しい情報については、「CodeQLランナー を CI システムで実行する」を参照してください。

このドキュメントは役立ちましたか?

プライバシーポリシー

これらのドキュメントを素晴らしいものにするのを手伝ってください!

GitHubのすべてのドキュメントはオープンソースです。間違っていたり、はっきりしないところがありましたか?Pull Requestをお送りください。

コントリビューションを行う

OR, コントリビューションの方法を学んでください。

問題がまだ解決していませんか?