如何通过GitHub Actions实现TS代码构建并在main分支提交时推送到生产分支?
GitHub Actions 自动构建TS并推送生产分支实现方案
前置准备
- 确认你的项目
package.json中存在可正常执行的build脚本,执行npm run build后能将TypeScript编译产物输出到指定目录(通常为dist或build文件夹) - 提前在GitHub仓库中创建好用于存放构建产物的生产分支(比如命名为
production)并推送至远端
配置Workflow文件
在项目根目录新建路径为.github/workflows/build-and-deploy.yml的配置文件,填入以下内容:
# 触发条件:main分支有新提交时自动执行 on: push: branches: - main # 配置GITHUB_TOKEN的写入权限,用于推送代码到生产分支 permissions: contents: write jobs: build-and-deploy: runs-on: ubuntu-latest steps: # 1. 拉取当前仓库代码 - name: Checkout code uses: actions/checkout@v4 # 2. 配置Node.js环境,可根据你的项目需求修改Node版本 - name: Setup Node.js uses: actions/setup-node@v4 with: node-version: 20 cache: 'npm' # 3. 安装依赖 - name: Install dependencies run: npm ci # 4. 执行TypeScript构建 - name: Build TypeScript code run: npm run build # 5. 将构建产物推送到生产分支 - name: Deploy to production branch uses: peaceiris/actions-gh-pages@v4 with: # 构建产物的本地目录,根据你的项目输出目录修改 publish_dir: ./dist # 目标生产分支名,根据你的实际分支名修改 publish_branch: production # 自动使用GitHub提供的凭证 github_token: ${{ secrets.GITHUB_TOKEN }} # 如果需要保留生产分支的历史文件可打开下面的注释,默认每次提交会覆盖旧内容 # keep_files: true
生效与验证
将新增的配置文件提交并推送到main分支后,打开仓库的Actions标签页即可查看工作流的执行状态,执行成功后对应生产分支就会更新为最新的构建产物。
常见调整项
- 若使用pnpm/yarn作为包管理器,将
npm ci和npm run build替换为对应命令即可 - 若构建过程需要传入环境变量,可在仓库
Settings > Secrets and variables > Actions中添加密钥,再通过env字段引入到workflow中 - 若构建产物不在
dist目录,修改publish_dir参数为你的实际输出路径即可
内容的提问来源于stack exchange,提问作者ToastOnAStick
相关产品推荐
相关产品推荐

