GitHubActionsでsedコマンドを使ってCI/CDツールにアンコメントアウトさせよう!

Last updated at 2024-08-06Posted at 2024-08-05

はじめに

Next.jsをGithubPagesでデプロイさせるという記事を以前書いたのですが、どうしてもGithubActionsの設定で生成したymlファイルをそのまま使用すると、静的エクスポート設定ができず、開発環境から本番環境へのCDをスムーズに行えないため、GithubActionsにmainブランチへプッシュやマージを行った際に、本番環境への移行を自動的に行ってもらおうと考えました。

CD:継続デリバリーのことで自動的にホスト先にデプロイすること

静的エクスポート:Node.jsを必要とせずに、静的なHTML、CSS、JavaScriptのファイルを提供し、クライアント(ブラウザ）のみで動作できるようにすること。

私の開発環境からGitHubActionsを用いたGithubPagesへの本番環境の移行には、next.config.mjsに書かれているoutput: 'export'をアンコメントアウトして静的エクスポート設定する必要がありました。

/** @type {import('next').NextConfig} */
const nextConfig = {
    // output: 'export'
};

export default nextConfig;

なので今回はymlファイルにアンコメントアウトをさせる方法を調べてみました。

やり方

元々のymlファイルは以下のようになっていました。

# Sample workflow for building and deploying a Next.js site to GitHub Pages
#
# To get started with Next.js see: https://nextjs.org/docs/getting-started
#
name: Deploy Next.js site to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Detect package manager
        id: detect-package-manager
        run: |
          if [ -f "${{ github.workspace }}/yarn.lock" ]; then
            echo "manager=yarn" >> $GITHUB_OUTPUT
            echo "command=install" >> $GITHUB_OUTPUT
            echo "runner=yarn" >> $GITHUB_OUTPUT
            exit 0
          elif [ -f "${{ github.workspace }}/package.json" ]; then
            echo "manager=npm" >> $GITHUB_OUTPUT
            echo "command=ci" >> $GITHUB_OUTPUT
            echo "runner=npx --no-install" >> $GITHUB_OUTPUT
            exit 0
          else
            echo "Unable to determine package manager"
            exit 1
          fi
      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: "20"
          cache: ${{ steps.detect-package-manager.outputs.manager }}
      - name: Setup Pages
        uses: actions/configure-pages@v5
        with:
          # Automatically inject basePath in your Next.js configuration file and disable
          # server side image optimization (https://nextjs.org/docs/api-reference/next/image#unoptimized).
          #
          # You may remove this line if you want to manage the configuration yourself.
          static_site_generator: next
      - name: Restore cache
        uses: actions/cache@v4
        with:
          path: |
            .next/cache
          # Generate a new cache whenever packages or source files change.
          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
          # If source files changed but packages didn't, rebuild from a prior cache.
          restore-keys: |
            ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-
      - name: Install dependencies
        run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
      - name: Build with Next.js
        run: ${{ steps.detect-package-manager.outputs.runner }} next build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./out

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

めっちゃ長い...

この内容は、GithubActionsの設定で出してくれるNext.js用のymlファイルです。

ここに以下のコマンドを加えることでアンコメントアウトを行うことができます。

- name: Uncomment output
    run: |
        sed -i "s/\// output: 'export'/output: 'export'" next.config.js

name

nameは行う作業のことを示しており、本番環境とNext.jsに認識させるoutputをアンコメントアウトするよと話しています。

runの部分では、行うコマンドを記述しています。

|( パイプ記号)

runの横にある|は、パイプ記号といって複数のコマンドを実行する際に使用します。

さて、ここが本題でrunコマンドに記述されているsedコマンドが、今回はアンコメントアウトを行うのに重要なコマンドとなっています。

sedコマンドとは、文字列の置換や削除に用いられるコマンドで、以下のように使用することで文字列の置換を行うことができます。

sed -i "s/<置換したいコードの箇所>/<置換したい内容>" <ファイル名>

今回で言うと、<置換したいコードの箇所>はコメントアウトされている// output: 'export'にあたり、それをアンコメントアウトした状態であるoutput: 'export'に置換しています。-iは直接ファイルを上書きするオプションです。

このコードをBuild with Next.jsより前に記述することで、ビルドされるより前の時点で本番環境用にファイルを書き換えることができます。

最終的なファイル

実際に、自分は下のようになりました。

# Sample workflow for building and deploying a Next.js site to GitHub Pages
#
# To get started with Next.js see: https://nextjs.org/docs/getting-started
#
name: Deploy Next.js site to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Detect package manager
        id: detect-package-manager
        run: |
          if [ -f "${{ github.workspace }}/yarn.lock" ]; then
            echo "manager=yarn" >> $GITHUB_OUTPUT
            echo "command=install" >> $GITHUB_OUTPUT
            echo "runner=yarn" >> $GITHUB_OUTPUT
            exit 0
          elif [ -f "${{ github.workspace }}/package.json" ]; then
            echo "manager=npm" >> $GITHUB_OUTPUT
            echo "command=ci" >> $GITHUB_OUTPUT
            echo "runner=npx --no-install" >> $GITHUB_OUTPUT
            exit 0
          else
            echo "Unable to determine package manager"
            exit 1
          fi
      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: "20"
          cache: ${{ steps.detect-package-manager.outputs.manager }}
      - name: Setup Pages
        uses: actions/configure-pages@v5
        with:
          # Automatically inject basePath in your Next.js configuration file and disable
          # server side image optimization (https://nextjs.org/docs/api-reference/next/image#unoptimized).
          #
          # You may remove this line if you want to manage the configuration yourself.
          static_site_generator: next
      - name: Restore cache
        uses: actions/cache@v4
        with:
          path: |
            .next/cache
          # Generate a new cache whenever packages or source files change.
          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
          # If source files changed but packages didn't, rebuild from a prior cache.
          restore-keys: |
            ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-
      - name: Uncomment output #追加
        run: |
            sed -i "s/\// output: 'export'/output: 'export'" next.config.js
      - name: Install dependencies
        run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
      - name: Build with Next.js
        run: ${{ steps.detect-package-manager.outputs.runner }} next build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./out

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

最後に

ymlファイルに実行する内容を追記させることで簡単にCDが行えるようになります。
もし今回のようなCDの設定をせっていを設定を行なってみたいという方はぜひ参考にしてください.

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up

GitHubActionsでsedコマンドを使ってCI/CDツールにアンコメントアウトさせよう!

はじめに

やり方

name

run

|( パイプ記号)

sed

最終的なファイル

最後に