Vue项目打包部署到GitHub Pages

Vue项目打包部署到GitHub Pages

前言

关于什么是github pages？怎样创建github 仓库上传本地项目到GitHub远程仓库？等基本操作本文不再赘述，初学者可以通过搜索找到大量文章教程。本文重点在于：

如何将vue项目源码（含dist目录）同步到到github仓库，同时单独将项目下的dist目录同步到gh-pages分支以便使用GitHub pages 发布和预览静态网页。

• 针对以上问题，作者以往的做法是将Vue项目源码托管到源码仓库，然后另外创建一个webpage仓库管理dist目录。然后针对webpage仓库开启GitHub pages 功能。实现GitHub pages访问Vue生成的静态页面
• 上述操作适用于不想公开源码仓库，同时又想免费使用GitHub pages 服务的情形，通常情况下一些个人的demo项目或是开源项目等仓库本身就是公开的，使用上述方法同时需要管理两个仓库，操作麻烦，最近了解到可以使用git subtree push --prefix dist origin gh-pages指令将项目下dist目录单独推送到远程仓库的gh-pages分支然后再将GitHub pages的source切换到gh-pages分支即可使用GitHub pages服务,到master分支管理源码gh-pages分支部署GitHub pages的目的

前期准备

1. 编译调试通过的Vue项目
2. 将本地项目推送到Github远程仓库默认master分支

步骤1和步骤2这方面的文章和教程不要太多，此处略过

重要说明

• 关于Vue项目的publicPath
  • 如果你打算发布到 https://.github.io/，则可以省略这一步，因为 publicPath默认即是 “/”。
  • 如果你打算发布到 https://.github.io/<REPO>/（也就是说你的仓库在 https://github.com/<USERNAME>/<REPO>），则将 publicPath 设置为 “/<REPO>/”。

<PERO>即你的仓库名称

步骤1

• 执行npm run build打包Vue项目，此时项目目录下会多出一个dist目录
  

步骤2

• 将dist推送到远程仓库（默认为master分支）

通常dist目录会被git忽略，需要将dist从忽略文件中删除，然后将dist目录推送到远程仓库​

步骤3 🚨

• 使用git subtree push --prefix dist origin gh-pages将dist目录推送到远程的gh-pages分支，若远程没有gh-pagse分支则会新建gh-pagse分支然后再推送。

备注：此处只能是gh-pages分支，才能使用GitHub pages功能

步骤4

• 登录远程GitHub仓库，通过setting -> github pages -> source 将gh-pages设置为GitHub pages 的source
  

步骤5

• 访问GitHub pages 链接

步骤6

• 每次执行npm run build 后再次执行步骤2，步骤3

---

🚀 我的demo链接为demo pages
🚀我的demo仓库地址为demo repository

---

(完)