将Vue3项目部署到Github Page

背景

工作中使用 vue 开发项目,部署测试环境就是把构建好的 dist 包放到服务器的指定目录。如果想要自己倒腾一个小网站呢,又不想买服务器费钱费力,那免费的 Github Page 很值得推荐。

实现步骤

  1. 假定已经有一个 vue 项目,并且提交到了 github 仓库。
  2. 设置和部署,打开项目中的vite.config.ts,找到下面代码块,更改为对应的 github 仓库名称
ts 复制代码
export default defineConfig({
    base: '/sycamore-cottage/', // github仓库名称
    plugins: [],
})
  1. 创建 gh-pages 分支,并将打包的 dist 文件夹下的所有东西上传到gh-pages 分支 注意 ⚠️:一般情况下"/dist "文件夹会被写进本地 .gitignore"(规定哪些文件会被 git 忽略不进行版本控制),所以如果 gitignore 文件有有 dist,要先暂时移除掉。执行以下命令进行提交。
shell 复制代码
npm run build
git subtree push --prefix dist origin gh-pages
  1. 更改 github page 设置 打开 github 仓库的 setting 配置,选择 Pages 配置项,Source 项选择 Deploy from a branch,Branch 项选择 gh_pages 分支下的/(root)文件夹。

  2. 验证是否部署成功。 访问user.github.io/repo, user为github用户名,repo为github仓库名,例如本例的地址为AprilTong.github.io/sycamore-co...

方法二自动部署

在方法一部署好之后,感觉每次要更新,都需要手动将 dist 目录上传到 gh-pages 分支,比较麻烦。联想到公司项目是通过 gitlab-runner 配置提交到指定分支然后自动构建。然后进行搜索,果然有!

  1. 和上述一样,需要更改的vite.config.ts
  2. 进入仓库 settings 页面的 GitHub Pages 配置,选择部署来源为"GitHub Actions"
  3. 选择创建一个 workflow , 文件命名为 main.yml,查看我的项目配置
shell 复制代码
 # 推送到指定分支时运行
 push:
    branches: ['master']
  1. 修改代码提交到你配置的分支试试吧。在 actions 中就可以看到构建流程了。点击可查看报错等细节。

参考文章

相关推荐
学习同学14 小时前
从0到1制作一个go语言游戏服务器(二)web服务搭建
服务器·前端·golang
-D调定义之崽崽14 小时前
【初学】调试 MCP Server
前端·mcp
四月_h15 小时前
vue2动态实现多Y轴echarts图表,及节点点击事件
前端·javascript·vue.js·echarts
文心快码BaiduComate15 小时前
用Zulu轻松搭建国庆旅行4行诗网站
前端·javascript·后端
真智AI15 小时前
[特殊字符] AI时代依然不可或缺:精通后端开发的10个GitHub宝藏仓库
人工智能·github·系统设计·后端开发·github资源·编码实践
正义的大古16 小时前
OpenLayers地图交互 -- 章节十八:拖拽旋转和缩放交互详解
javascript·vue.js·openlayers
行者..................16 小时前
手动编译 OpenCV 4.1.0 源码,生成 ARM64 动态库 (.so),然后在 Petalinux 中打包使用。
前端·webpack·node.js
小爱同学_17 小时前
一次面试让我重新认识了 Cursor
前端·面试·程序员
golang学习记17 小时前
AI 乱写代码?不是模型不行,而是你的 VS Code 缺了 Context!MCP 才是破局关键
前端
星光不问赶路人17 小时前
Vite 中的 import.meta.glob vs 动态导入:该用哪个?
前端·vite