env-replacer

English

GitHub Actions の Secrets で .env ファイルの値を置換する Composite Action。

.env に存在するキーだけを対象に置換するため、不要な Secrets が混入しない。

使い方

基本：

steps:
  - uses: actions/checkout@v4

  - uses: nnahito/env-replacer@main
    with:
      secrets: ${{ toJSON(secrets) }}
      copy-from-example: 'true' # ← 任意: .envファイルを.env.exampleから利用するかどうか。true or falseを指定する。デフォルトはfalse
      env-file: 'subdir/.env'  # ← 任意: .envが実行ディレクトリ外にある場合に指定。省略時は.envがデフォルト値
      env-example: '.env.example' # ← 任意: .env.exampleが実行ディレクトリ外にある場合に指定。省略時は.env.exampleがデフォルト値

環境ごとに値を切り替える（prod / stage など）

GitHub の Environments 機能と組み合わせることで、シェルスクリプト不要で環境ごとの値を切り替えられる。

Secrets の登録方法

• リポジトリ Secrets（共通値）: DB_PASSWORD など全環境で共通のものを登録
• Environment Secrets（差分のみ）: 環境ごとに変わる値だけを登録。同名 Secret はリポジトリ側の値を上書きする

リポジトリ Secrets（共通）
  DB_PASSWORD=xxxx
  APP_DEBUG=true

prod Environment Secrets
  APP_ENV=production
  APP_DEBUG=false        # リポジトリ側を上書き
  APP_URL=https://example.com

stage Environment Secrets
  APP_ENV=stage
  APP_URL=https://stage.example.com

ワークフローの設定

environment: を1行追加するだけで、対象 Environment の Secrets が自動的に適用される。

jobs:
  deploy:
    environment: ${{ github.event.inputs.target }}
    steps:
      - uses: actions/checkout@v4

      - uses: nnahito/env-replacer@main
        with:
          secrets: ${{ toJSON(secrets) }}