delete-artifact GitHub Action 使用教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00710/article/details/142810779

delete-artifact GitHub Action 使用教程

delete-artifact A GitHub Action to deletes artifacts within the workflow run. 项目地址: https://gitcode.com/gh_mirrors/de/delete-artifact

1. 项目介绍

delete-artifact 是一个 GitHub Action，用于删除工作流运行中的工件（artifacts）。这个 Action 在工件在多个作业之间共享但不再需要时非常有用。它兼容 actions/upload-artifact，并且支持多个版本的引用。

2. 项目快速启动

2.1 安装与配置

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

name: Delete Artifact Example

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Create test file
        run: echo "hello" > test.txt

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

      - name: Delete artifact
        uses: geekyeggo/delete-artifact@v5
        with:
          name: my-artifact

2.2 运行工作流

提交并推送你的更改，GitHub Actions 将自动触发并执行上述工作流。你可以在 GitHub 仓库的 Actions 选项卡中查看工作流的执行情况。

3. 应用案例和最佳实践

3.1 删除单个工件

在某些情况下，你可能只需要删除一个特定的工件。以下是一个示例：

steps:
  - name: Delete single artifact
    uses: geekyeggo/delete-artifact@v5
    with:
      name: my-artifact

3.2 删除多个工件

如果你有多个工件需要删除，可以使用以下方式：

steps:
  - name: Delete multiple artifacts
    uses: geekyeggo/delete-artifact@v5
    with:
      name: |
        artifact-*
        binary-file
        output

3.3 错误处理

默认情况下，如果无法删除工件，Action 会失败。如果你希望在删除失败时不影响工作流的执行，可以设置 failOnError: false：

steps:
  - name: Delete artifact with error handling
    uses: geekyeggo/delete-artifact@v5
    with:
      name: okay-to-keep
      failOnError: false