GitHub Actions 上传工件教程

1. 项目介绍

actions/upload-artifact 是一个 GitHub Actions 的官方 Action，用于在 GitHub Actions 工作流中上传构建工件（Artifacts）。工件可以是构建输出、测试结果、日志文件等，这些文件可以在工作流的不同步骤或不同作业之间共享。上传的工件可以在 GitHub 仓库的 Actions 页面中查看和下载。

2. 项目快速启动

2.1 安装和配置

首先，确保你已经在 GitHub 仓库中启用了 GitHub Actions。接下来，在你的工作流文件（通常是 .github/workflows/ 目录下的 .yml 文件）中添加以下内容：

name: Upload Artifact Example

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2

    - name: Create a file
      run: echo "Hello, World!" > my-artifact.txt

    - name: Upload Artifact
      uses: actions/upload-artifact@v4
      with:
        name: my-artifact
        path: my-artifact.txt

2.2 运行工作流

将上述配置保存到你的工作流文件中，然后提交并推送到 GitHub 仓库。GitHub Actions 会自动触发工作流，并在完成后上传 my-artifact.txt 文件作为工件。

3. 应用案例和最佳实践

3.1 上传构建输出

在 CI/CD 流程中，通常需要将构建输出上传为工件，以便后续步骤或作业使用。例如，上传编译后的二进制文件：

- name: Build the project
  run: make build

- name: Upload Build Artifact
  uses: actions/upload-artifact@v4
  with:
    name: build-output
    path: ./build

3.2 上传测试结果

在测试阶段，可以将测试结果上传为工件，以便在 GitHub Actions 页面中查看：

- name: Run tests
  run: make test

- name: Upload Test Results
  uses: actions/upload-artifact@v4
  with:
    name: test-results
    path: ./test-results

3.3 最佳实践

• 命名规范：为工件命名时，使用有意义的名称，以便在 GitHub Actions 页面中轻松识别。
• 路径选择：确保上传的路径正确，避免上传不必要的文件。
• 压缩级别：根据需要调整压缩级别，以平衡上传速度和文件大小。

4. 典型生态项目

4.1 actions/download-artifact

actions/download-artifact 是 actions/upload-artifact 的配套 Action，用于下载之前上传的工件。它通常用于在不同的作业或步骤之间共享数据。

- name: Download Artifact
  uses: actions/download-artifact@v4
  with:
    name: my-artifact

4.2 actions/checkout

actions/checkout 是 GitHub Actions 中常用的 Action，用于检出代码库。通常在 upload-artifact 之前使用，以确保代码库已准备好。

- uses: actions/checkout@v2

4.3 actions/setup-node

actions/setup-node 用于设置 Node.js 环境，通常在需要构建或测试 Node.js 项目时使用。

- name: Set up Node.js
  uses: actions/setup-node@v2
  with:
    node-version: '14'

通过这些生态项目的组合使用，可以构建出功能强大的 CI/CD 工作流。