Github Actions – DECODE X NET

Github にpushすると同時にワークフローを実行してくれるGithub Actionsを試して見ました。
Next.jsを使った静的ベージを生成するブログプログラムを使ってpushした投稿がGithub Pageで表示されることを確認しました。

コード
https://github.com/systemsblue/betalogg

ブログ
https://systemsblue.github.io/betalogg/

Github　PageにNext.jsのプログラムをデプロイする情報はネットにいろいろとありますが、下記ワークフローファイルが正しくないと失敗してしまいます。
このファイルは、Settings/Pagesから自動的に生成させることができますが、78、79行目のnext export の部分をコメントアウトしました。

https://github.com/systemsblue/betalogg/blob/main/.github/workflows/nextjs.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@v4
        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@v3
        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: Static HTML export with Next.js
      #  run: ${{ steps.detect-package-manager.outputs.runner }} next export
      - 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

# 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

- 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@v4

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@v3

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: Static HTML export with Next.js

# run: ${{ steps.detect-package-manager.outputs.runner }} next export

- 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

build,deployのワークフローが確認できます。とりあえず動くものができたことは、安心です。これを参考にいろいろとコマンド実行をテストしていきたいです。自動で生成されるということは変化する可能性があリますので、ここにメモっておきます。

正しくbuild,deployができると上記のように表示されます。ArtifactsからはNext.jsのビルド後のファイルがダウンロードできます。
この仕組みをGithubで手軽に試せることはとても興味深いです。Next.jsとGithub Actionsの相性がとても良いと感じました。