github-actions-workflow-yaml

GitHub Actions 工作流 YAML 指南与说明 1. 基本结构 工作流文件使用 YAML 格式，通常保存在 `.github/workflows/` 目录下。每个文件定义一个或多个工作流，由事件触发执行。 2. 关键字段说明 - `name`（可选）：工作流的名称，显示在 GitHub 仓库的 Actions 标签页中。 示例： ```yaml name: CI ``` - `on`（必需）：定义触发工作流的事件。可以是单个事件、事件列表或事件配置对象。 常见事件： - `push`：代码推送时触发 - `pull_request`：拉取请求时触发 - `schedule`：定时触发（使用 cron 表达式） - `workflow_dispatch`：手动触发 示例： ```yaml on: [push, pull_request] ``` 或带过滤条件： ```yaml on: push: branches: - main - 'releases/**' pull_request: branches: [main] ``` - `jobs`（必需）：定义一个或多个作业。每个作业在独立的虚拟环境中运行。 每个作业包含： - `name`：作业名称（可选） - `runs-on`：指定运行环境（如 `ubuntu-latest`、`windows-latest`、`macos-latest`） - `steps`：作业中的步骤列表 - `needs`：定义作业依赖关系（可选） - `if`：条件执行（可选） - `env`：环境变量（可选） - `strategy`：矩阵策略（可选，用于并行运行多个配置） 示例： ```yaml jobs: build: name: Build Project runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: '20' - name: Install dependencies run: npm install - name: Run tests run: npm test ``` 3. 步骤（steps）说明 每个步骤可以是： - `uses`：使用预定义的操作（action） - `run`：执行 shell 命令 - `name`：步骤名称（推荐） - `if`：条件执行 - `env`：设置环境变量 - `working-directory`：指定工作目录 示例： ```yaml steps: - name: Checkout code uses: actions/checkout@v4 - name: Setup Python uses: actions/setup-python@v5 with: python-version: '3.11' - name: Install dependencies run: pip install -r requirements.txt working-directory: ./src - name: Run lint run: flake8 . if: ${{ success() }} ``` 4. 环境变量 - 全局环境变量： ```yaml env: NODE_ENV: production ``` - 步骤级环境变量： ```yaml steps: - name: Deploy run: ./deploy.sh env: API_KEY: ${{ secrets.API_KEY }} ``` 5. 使用 Secrets 敏感信息（如 API 密钥）应通过 GitHub Secrets 管理，...

存档时间线

版本索引永久保留；内容副本只保留最新 1 份，更早版本仅留索引与哈希（存档时间线的证据链不会因此断裂）。

下载存档内容副本

相关资产