next项目部署到GitHub模板

最新推荐文章于 2025-03-08 12:21:53 发布

原创最新推荐文章于 2025-03-08 12:21:53 发布 · 690 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#github

web 专栏收录该内容

30 篇文章

订阅专栏

本文介绍如何利用GitHub Action自动化部署Next.js项目到GitHub Pages。通过配置特定的YAML文件，实现每次推送代码到main分支时自动构建并发布静态网站。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

使用github action 将next项目部署到GitHub pages的模板：

在项目根目录下新建.github/workflows 目录，并在其下新建一个 yaml文件，文件名字任意。

在文件中写入以下模板，并推送到github仓库即可（可按需更改，模板可通过github pages页面 - 通过github actions部署选项中获取）：

在这里插入图片描述

name: deploy Next.js site to Pages
on:
  push:
    branches: ["main"]
  # 允许手动运行此工作流
  workflow_dispatch:
# 设置 GITHUB_TOKEN 的权限以允许部署到GITHUB页面
permissions:
  contents: read
  pages: write
  id-token: write
# 允许一个并发部署
concurrency:
  group: "pages"
  cancel-in-progress: true

# 部署设置与步骤
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Detect package manager
        id: detect-package-manager
        run: |
          if [ -f "${{ github.workspace }}/yarn.lock" ]; then
            echo "::set-output name=manager::yarn"
            echo "::set-output name=command::install"
            echo "::set-output name=runner::yarn"
            exit 0
          elif [ -f "${{ github.workspace }}/package.json" ]; then
            echo "::set-output name=manager::npm"
            echo "::set-output name=command::ci"
            echo "::set-output name=runner::npx --no-install"
            exit 0
          else
            echo "Unable to determine packager manager"
            exit 1
          fi
      - name: Setup Node
        uses: actions/setup-node@v3
        with:
          node-version: "16"
          cache: ${{ steps.detect-package-manager.outputs.manager }}
      - name: Setup Pages
        uses: actions/configure-pages@v2
        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@v1
        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@v1