サーバレスアーキテクチャ

GitlabのCI/CDで環境変数を使う方法

プログラムをビルドをする際に、ローカルや本番といった環境変数(env)を指定したいことがあります。今回は、GitlabのCI/CDで環境変数を使う方法をまとめました。

Gitlab CI/CDで環境変数を設定する方法は2種類ある

Gitlab CI/CDでは、GUIとファイルの2種類の環境変数の設定方法があります。

それぞれのやり方を見ていきましょう。

管理画面から追加する方法

一つ目は、Gitlabの管理画面から環境変数を追加方法です。

Gitlabのサイトのレポジトリページに行って、左の「レポジトリの設定メニュー(歯車アイコンのSettings)から「CI/CD」をクリックすると「Variables」という項目があるので、keyとvalueを追加して保存すればOKです。

この方法は、Gitlabの当該レポジトリへのアクセス権がないユーザーはタッチできないところに環境変数を置くため、クラウドサービスやAPIのセキュリティキーなどを、「ファイルでおいて置きたくない情報」を設定するのに最適です。

次に説明するファイル方式と違って、ファイルで保存しなくて良いので、セキュリティを高めることができます

設定ファイル(.gitlab-ci.yml)で追加する方法

もう一つの方法は、Gitlab CI/CDの設定ファイルに記述する方法です。

GitlabのCI/CDは「.gitlab-ci.yml」という独自の設定ファイルで指定をしますが、そちらでも環境変数を設定できます。

variables:
  TEST: "HELLO WORLD" // KEY: VALUE形式

こちらはレポジトリにファイルが残ってしまうので、セキュリティキーなどの外部流出すると困るものは記載しない方が良いでしょう。

逆に「VUE_ENV=production」といった、外部に漏れても問題ないような環境変数については、設定ファイルに記述しておいたほうが、あとで「どこで環境変数を設定していたっけな?」と迷子にならない意味でも便利です。


GitlabのCI/CDで環境変数を使う方法を見てきました。

一度理解してしまえば簡単なのですが、頻繁に使う項目でもないのでうっかり忘れてしまわないようにしましょう。

なお、より詳細な設定についてはGitlabの公式ドキュメントに説明がありますので、そちらも併せてどうぞ。

参考:Creating a custom environment variable | Gitlab Docs


価格は記載がある場合を除き、すべて税込みです。

この記事の関連キーワード

サーバレスアーキテクチャの記事