admin 发表于 2024-11-15 17:56:20

GitHub Actions YAML配置

GitHub Actions 常量、描述及示例:
| 常量          | 描述                                                         | YAML 示例             | 渲染结果         |
|-----------------|-------------------------------------------------------------|----------------------|--------------------|
| `name`         | 工作流/作业/步骤名称                                       | `name: CI Workflow` | `CI Workflow`       |
| `on`         | 触发事件 (e.g., `push`, `pull_request`)                      | `on: push`         | `push`             |
| `jobs`         | 定义多个作业                                             | `jobs: build`      | `build`            |
| `runs-on`      | 执行环境 (操作系统)                                       | `runs-on: ubuntu-latest` | `ubuntu-latest`   |
| `steps`      | 作业步骤                                                   | `steps:`             | `[步骤1, 步骤2]`   |
| `uses`         | 使用外部 Action                                             | `uses: actions/checkout@v2` | `actions/checkout@v2` |
| `with`         | 传递参数                                                   | `with: {version: '1.0.0'}` | `version: 1.0.0`   |
| `env`          | 环境变量                                                   | `env: {MY_ENV_VAR: 'value'}` | `MY_ENV_VAR: value` |
| `run`          | 运行命令                                                   | `run: echo "Hello"`| `echo "Hello"`   |
| `id`         | 作业节点ID                                                 | `id: Hello`          | `id: Hello`         |
| `continue-on-error` | 错误时是否继续执行                                       | `continue-on-error: true` | `true`             |
| `timeout-minutes` | 超时时间(分钟)                                          | `timeout-minutes: 10` | `10`               |
| `if`         | 条件表达式                                                 | `if: success()`       | `success()`         |
| `matrix`       | 矩阵作业环境组合                                          | `matrix.os`          | `ubuntu-20.04`   |
| `fail-fast`    | 矩阵作业失败时是否终止                                     | `fail-fast: true`    | `true`             |
| `cancel-in-progress` | 运行新作业时是否取消进行中的作业                           | `cancel-in-progress: true` | `true`             |
| `runs`         | 作业运行环境                                             | `runs: ubuntu-latest` | `ubuntu-latest`   |
| `path`         | 文件路径                                                   | `path: ./my-folder/*` | `./my-folder/*`    |
| `services`   | 外部服务                                                   | `services: mysql:5.7` | `mysql:5.7`      |
| `permissions`| 权限控制                                                   | `permissions: write-all` | `write-all`      |
| `outputs`      | 作业输出                                                   | `outputs: result`   | `result: success`|
| `secrets`      | 机密信息                                                   | `secrets.MY_SECRET`   | `my_secret_value`|
| `needs`      | 作业依赖                                                   | `needs: `       | `job1`             |
| `strategy`   | 作业策略                                                   | `strategy: matrix`   | `matrix`         |
| `status`       | 工作流/作业状态                                             | `if: failure()`       | `failure()`         |
| `artifact`   | 上传工件                                                   | `name: my-artifact`| `upload-artifact`|
页: [1]
查看完整版本: GitHub Actions YAML配置