Play Video: How to Use GitHub Actions Environment Variables and Secrets
動作する コードを 本番環境へ 効率よく リリースするには、 継続的インテグレーション/継続的デリバリー (CI/CD) パイプラインを 導入するのが 効果的です。 こうした パイプラインは、 コード変更が リリース可能かどうかを 確認する プロセスを 自動化し、 本番環境への リリースを 自動化する ツールを 提供します。
その 一般的な 方法の 一つが、 既存の バージョン管理システムを 利用する ことです。 GitHubは 広く 使われている バージョン管理システムの 一つで、 開発者が コードの ビルド、 テスト、 デプロイを 自動化できる GitHub Actionsを 提供しています。 これに より、 安全な CI/CDパイプラインの 構築 が 可能に なります。
GitHub Actionsの ジョブでは、 環境変数への アクセスが 必要に なることが よく あります。 環境変数は あらかじめ定義でき、 特定の 環境で 実行される パイプラインからのみ アクセスできます。 これに より、 環境変数に 応じて CI/CDパイプラインの 動作を 変更できます。 たとえば、 本番環境への デプロイ前に、 アプリケーションの 最適化された 本番用バージョンを ビルドするよう 切り 替えられます。
この 記事では、 GitHub Actionsで 利用できる 環境変数と、 その 使いどころを 実践的に 解説します。
前提条件 この チュートリアルを 進めるには、 次の ものが 必要です。
開発中に プロジェクトを スキャンできる Visual Studio Code用の Snyk プラグイン を ご存じですか? 詳しくは ドキュメント を ご覧ください。
GitHub Actionsの環境変数でできること サンプルコードを ダウンロードしたら、 GitHubで 新しい リポジトリを 作成し、 サンプルコードを 追加します。
サンプルコードには、 GitHub Actionsの ワークフローファイルの 例が すでに 含まれています。 以下の コードは、 ファイル .github/workflows/pipeline.ymlの 内容です。
この ファイルでは、 Mavenを 使って Javaアプリケーションを ビルドする シンプルな ワークフローを 定義しています。
ワークフローの YAML設定ファイルでは、 ワークフロー、 ジョブ、 ステップの 3つの レベルで 環境変数を 定義できます。 これらの レベルに よって、 環境変数の 適用範囲が 決まります。 ワークフローレベルの 環境変数は ワークフロー全体に 適用されます。 ジョブレベルの 環境変数は 特定の ジョブに 適用されます。 ステップレベルの 環境変数は 特定の ステップに 適用されます。
それぞれの 環境変数を 詳しく 見ていきましょう。
ワークフローレベルの環境変数 ワークフローレベルの 環境変数を 設定するには、 YAMLファイルの 最上位で 定義します。 ファイル上部の NAME変数の 下に、 次の 内容を 追加しましょう。
この コードでは、 NAMEと いう 環境変数を 定義しています。 この 変数は、 ワークフロー内の どこからでも 参照できます。 変数に アクセスするには、 UNIXの 環境変数と 同様の 専用構文を 使います。 NAME変数を 使うには、 先頭に ドル記号を 付けて $NAMEと します。
23行目に、 この 変数を 出力する 新しい ステップを 追加しましょう。
この 変更を コミットし、 リポジトリに プッシュします。
次に、 ブラウザーで GitHubを 開き、 リポジトリの Actions タブに 移動します。 Jobs の 下に ある 最新の ワークフローを 選択し、 ビルドジョブの 出力を 開きます。 Print name を クリックします。 展開すると、 下の 画像のように 環境変数が 正しく 出力されている ことを 確認できます。
ワークフローレベルの 環境変数は、 すべての ジョブと ステップに 適用する 変数の 宣言に 便利です。 たとえば、 ワークフローが 実行される 環境を 開発、 テスト、 本番の いずれかに 設定できます。 npmで ビルドする Node.jsアプリケーション では、 NODE_ENV変数を 利用できる ため、 特に 便利です。 この 変数を 使うと、 各ジョブが 環境に 応じて 適切に 動作します。 npmパッケージを 安全に 公開する 方法に ついては、 Snykブログの こちらの 記事 を ご覧ください。
ジョブレベルの環境変数 次に、 ジョブと ステップの 環境変数を 設定する 方法を 見てみましょう。 ワークフローレベルの 環境変数と 同じ 方法で 設定できますが、 該当する セクション内で 定義します。
ジョブの 変数と して、 Javaの バージョンを 次のように 定義します。
これで、 各ステップ内で 前述と 同じように この 変数を 使えます。
ただし、 JAVA_VERSION環境変数を 使う ときは、 構文が 少し 異なることに 気づくでしょう。 これは コンテキスト を 使って 環境変数に アクセスする 例です。 コンテキストを 使うと、 GitHub Actionsは どの 仮想マシン上でも 環境変数を 利用できます。 これらの タスクは、 環境を 定義した 仮想マシンとは 別の 仮想マシンで 実行される 場合が ある ためです。
特定の ジョブで、 すでに 宣言した ワークフロー変数とは 異なる 値が 必要な 場合は、 ジョブレベルの 環境変数を 使って ワークフローレベルの 値を 上書きできます。 また、 変数の 適用範囲を 特定の ジョブだけに 限定する こともできます。
上の 例のように、 ジョブレベルの 環境変数で Javaの バージョンを 設定すると、 各ステップで その 変数を 使えます。 今後 Javaの バージョンを 変更する 場合も、 1か所を 変更するだけで、 ジョブ内の すべての ステップに 新しい バージョンが 自動的に 適用されます。
GitHub Actionsを 使っている 今なら、 Snykを 簡単に GitHub Actionsに 統合して、 すぐに プロジェクトを スキャンできます。 便利な Snyk GitHub Actionsの 事前構 築済みアクション を ご用意しています。 まだの 場合は Snykアカウント に 登録して、 今 すぐ スキャンを 統合 しましょう。
ステップレベルの環境変数 ステップ内で 変数を 定義する こともできます。 以下は、 ステップレベルの 環境変数の 例です。 pipeline.ymlファイルの Print name ステップを、 次の コードと 同じに なるように 変更します。
ステップレベルの 環境変数は、 適用範囲を 1つの ステップだけに 限定します。 特定の ステップで 使用する 入出力ファイルの パスを 定義する 場合などに 便利です。 上の コード例では、 ステップ変数を 使って 出力する テキストを 設定しています。
以下は、 新しい ジョブレベルおよびステップレベルの 環境変数を 追加した、 GitHubワークフローYAMLファイル全体の 例です。
この 新しい ワークフローを GitHubに チェックインして、 出力を 確認しましょう。 下の 画像のように 表示されるはずです。
コンテキストを 使って 環境変数を 設定すると、 出力ステップが 想定どおりに 動作します。
コンテキストを 使わずに 環境変数を 参照しようとすると、 次の エラーが 発生します。
これは、 setup-java actionが 同じ 環境に アクセスできないためです。 変数を 利用できるように するには、 コンテキストが 必要です。
デフォルト変数とGitHubシークレットの使用 環境変数を 定義するだけでなく、 GitHubは ワークフロー内で アクセスできる デフォルト変数 も 提供しています。 これらの 変数を 使うと、 GitHubリポジトリ、 GitHub Actions、 ワークフローの ランナーなどの 詳細情報を 取得できます。 ユーザー定義の 環境変数と 同じように 使用できます。 GitHub Actionsで 利用する 場合は、 適切な 箇所で コンテキストを 使って アクセスしてください。
最後に、 環境変数の 一種である GitHubシークレットが あります。 機密データを 含む 変数に 利用できます。 GitHubが 暗号化し、 ワークフロー内で 使用できるようにします。
GitHubで 暗号化された 環境変数を 作成するには、 リポジトリの Settings を 開き、 左側の メニューから Secrets and variables, 、 続いて Actions を 選択します。 次に、 New repository secret を クリックし、 シークレットの 名前と 値を 入力します。 下の 例のように API_KEYと いう シークレットを 作成し、 ランダムな 値を 設定してください。
ワークフロー内で シークレットを 使うには、 GitHub Actionsに 環境変数を 渡す ときと 同じ コンテキストの 構文を 使います。 ただし、 変数の 前に env.ではなく secrets.を 付けます。
ワークフローの YAMLファイルで 作成した print文に ${{secrets.API_KEY}}を 追加します。 次の コード例のようになります。
変更を コミットして リポジトリに プッシュします。 次に、 GitHubの Actions ページに 移動して、 最新の ワークフロー実行の 出力を 確認します。
ご覧の とおり、 GitHubは 暗号化された シークレットの 値を 自動的に マスキングする ため、 誤って 公開される ことは ありません。
GitHubシークレットは、 パスワードや API認証キーなどの 機密データの 保存に 役立ちます。 シークレットを 使えば、 こうした 値を ワークフローに ハードコードして 外部に 漏らすリスクを 避けられます。 GitHubが 値を 暗号化し、 ワークフロー内の アクションに 安全に 渡すため、 ログに 平文で 表示される こともありません。
まとめ この 記事では、 GitHub Actionsの 環境変数に ついて 解説しました。 環境変数の 3つの 適用範囲 (ワークフロー、 ジョブ、 ステップ)と、 それぞれの 範囲で 変数を 定義する 方法を 説明しました。 また、 コンテキストを 使って GitHub Actionsに 環境変数を 渡す方法と、 シークレットを 使って 機密性の 高い 変数を 暗号化する 方法も 紹介しました。
GitHub Actionsの 環境変数を 使うと、 動的な ワークフローを 構築できます。 ユーザー定義変数や GitHubの デフォルト変数に 応じて、 ワークフローの 動作を 変更できます。 ワークフロー全体、 特定の ジョブや ステップの 動作、 または 実行条件を 動的に 変更したい ときに、 環境変数を 活用しましょう。
この 記事では、 機密情報を 保護する 環境変数と して GitHubシークレットを 使う 方法も 紹介しました。 パスワードや APIキーなど 機密性の 高い 変数には、 必ず GitHubシークレットを 使いましょう。 GitHubが 値を 暗号化して ワークフローに 渡すため、 漏えいの リスクを 抑えられます。
セキュリティの 重要性も 忘れないでください。 Snykで GitHubワークフローに セキュリティを さらに 加える 方法を ご覧ください。 また、 コード、 コンテナ、 オープンソース、 IaCを 包括的に 保護する ための CI/CDパイプラインへの Snykの 統合 に ついても ご確認ください。