Github Actions 快速上手

发布于2023年09月25日

更新于2026年03月06日

分类开发基础

创建脚本

在项目根目录新建文件夹 .github/workflows 在该文件夹中创建 yaml 格式的脚本文件

设置密钥

设置密钥可以隐藏服务器 IP、SSH 端口等敏感信息

Project -> Settings -> Secrets -> Actions，在其中添加环境变量即可

配置脚本

脚本构成

• name：脚本的名字
• on：脚本的触发条件
• permissions：脚本权限
• jobs：脚本的具体工作

name

name: deploy-website

on

push 时触发

on:
  push:
    branches: ['master']

手动触发

on:
  workflow_dispatch:

permissions

permissions:
  contents: write

jobs

jobs:
  build:
    # 运行环境
    runs-on: ubuntu-latest

    steps:
      # 获取仓库文件
      - name: checkout
        uses: actions/checkout@v3

      # 设置Node版本（可选）
      - name: Setup Node
        uses: actions/setup-node@v3
        with:
          node-version: 16

      # 项目依赖安装及构建
      - name: Install and Build 🔧
        run: |
          npm install
          npm run build

      # 使用SCP部署至VPS（二选一）
      - name: Deploy
        uses: appleboy/scp-action@master
        with:
          host: ${{ secrets.HOST }}
          username: ${{ secrets.USERNAME }}
          password: ${{ secrets.PASSWORD }}
          port: ${{ secrets.PORT }}
          source: .vitepress/dist # 文件路径(./* 为全部)
          target: ${{ secrets.TARGET }} # 目标路径
          strip_components: 2 # 打包层数
          rm: true # 删除目录现存文件

      # 部署至Github Pages（二选一）
      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@releases/v3
        with:
          folder: .vitepress/dist
          branch: gh-pages