手摸手带你在github上自动部署应用

现成的可参考仓库:react-steps

  1. 在 github 新建仓库(略
  2. 添加 package.json 文件,提供对应打包命令,如:
json 复制代码
{
  "scripts": {
    "build": "tsc && vite build"
  },
}

不一定是 build,可以自定义,在下面的步骤里对应 build 相应替换即可

  1. 在项目根目录下,新建 .github/workflows/react-build.yml,内容如下:
yaml 复制代码
name: Build and Deploy

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout Repository
      uses: actions/checkout@v2

    - name: Setup Node.js
      uses: actions/setup-node@v2
      with:
        node-version: '16'

    - name: Install Dependencies
      run: npm install

    - name: Build React App with Vite
      run: npm run build

    - name: Deploy to GitHub Pages
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GH_TOKEN }}
        publish_dir: ./docs

其中的 ./docs 代表 npm run build 执行后打包出来的文件夹,GH_TOKEN 需要在 github 上来生成和配置,后面会讲到。

  1. github 上操作生成 GH_TOKEN

链接:github.com/settings/to...

  1. 在项目中配置 GH_TOKEN

复制刚生成的 token

在项目目录下,设置这个token

  1. 提交代码到 github
  2. github 会根据 .github/workflows/react-build.yml 文件来进行构建,首次构建完后会自动创建一个 gh-pages 分支,该分支里的代码为 npm run build 生成的目录下的代码以及一个自动生成的 文件 .nojekell 文件

其中的第二步到第六步,对应的是 .github/workflows/react-build.yml 配置中的 jobs 下的 steps。

  1. 配置 github-pages
  1. 在项目中配置在线预览访问地址:

访问的地址格式为:https://用户名.github.io/项目名

  1. 访问静态资源的根目录地址为 https://用户名.github.io 而真正的资源目录为 项目名/ 下,所以在打包时,html 里引入的地址,需要加入项目名,如下:

如果在一个 vite 打包的环境下,则可以在 vite.config.ts 中这样配置

ts 复制代码
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'

// https://vitejs.dev/config/
export default defineConfig({
  base: '/react-starter', // 这里配置为 github 对应的项目名
  build: {
    outDir: "docs",
  },
  plugins: [react()],
})

以上,整个自动打包配置就完成了。

相关推荐
程序员大阳33 分钟前
副队长Vue3教程(2)--Vite 搭建 Vue 项目,认识目录结构
前端·javascript·vue.js·vite·创建项目·目录结构·项目结构
濮水大叔41 分钟前
Cabloy/Zova 与 Next.js 的 SSR 水合差异
前端·typescript·next.js
SoaringHeart1 小时前
Flutter最佳实践:用 flutter_html 渲染富文本
前端·flutter
Flynt3 小时前
Chrome给AI编程助手塞了203篇前端规范,我拆包实测:检索0.77秒是真快,扫描器有点挑食
前端·chrome·ai编程
北城笑笑3 小时前
Vue 110 ,若依SSE流式接口限次空500排查与解决
前端·javascript·vue.js·后端·vue
程序员韩星3 小时前
OpenAI 兼容接口返回 404,先查请求地址,再查模型名
前端·人工智能·http
Patrick_Wilson3 小时前
构建通过了,为什么有些浏览器还会白屏?
前端·javascript·浏览器
其实防守也摸鱼4 小时前
用 Claude Code 重构遗留系统:从评估到落地的完整指南
前端·网络·人工智能·chrome·安全·重构
七仔啊4 小时前
CNC计算机数控加工模拟器
前端
张一凡935 小时前
你的 AGENTS.md,真的管到模型写代码了吗?
前端·后端·agent