从 GitHub Actions 中删除工作流

Question

我在存储库的.github/workflows文件夹中创建了几个工作流来试验 GitHub Actions。 从那以后，我学到了很多东西，并从我的仓库中删除了所说的“实验性”工作流程。 在删除“实验性”工作流 yaml 文件并提交删除后，当我 go 到我存储库的“操作”选项卡时，我仍然看到我已经删除的工作流。

我看不到删除并从头开始的选项？ 这不可能吗？ 是否可以通过 GitHub API。嗯。

Answer 1

自 2020 年 7 月 7 日起， 您现在可以删除单个工作流运行的结果。 为此，导航到您的工作流程，找到您要删除的工作流程运行，然后选择“...”菜单。 在此菜单中，选择“删除工作流运行”。

工作流运行及其日志将被删除。

目前，您必须为每个单独运行的工作流执行此操作。

编辑：截至 2021 年 2 月，似乎在删除所有工作流程运行后，工作流程自行消失。 下面的一条评论似乎也证实了这一点。

Answer 2

目前似乎没有一种方法可以删除这些工作流程——这毫无意义——但似乎一旦有人犯了创建一个错误，他们就会永远坚持下去。 到目前为止，我发现的唯一解决方案是禁用这些工作流程。

因此，如果我转到Actions 选项卡（编辑 url 以匹配您的 repo），然后我可以单击一个工作流并通过该选项卡右上角的 [...] 禁用它，如下面的快照所示：

一次删除所有工作流程结果

在此处删除记录是我在此处找到的解决方案，对原始版本稍作修改：

user=GH_USERNAME repo=REPO_NAME; gh api repos/$user/$repo/actions/runs \
--paginate -q '.workflow_runs[] | select(.head_branch != "master") | "\(.id)"' | \
xargs -n1 -I % gh api repos/$user/$repo/actions/runs/% -X DELETE

将GH_USERNAME和REPO_NAME替换为相应的 github 用户名和 repo 名称。

这将删除所有不在master分支上的旧工作流。 你可以进一步调整它来做你需要的。

先决条件：

• 您将在此处找到最新的gh版本。

笔记：

• 如果这是您第一次使用它，您可能需要gh auth login
• 如果您不想看到详细的输出，您可以进一步将命令更改为gh api --silent 。
• 对于命令链的最后xargs部分 - 原始使用-J而不是-I ，GNU xargs不支持。 -J产生一个命令，而-I将为每条记录执行命令，所以它有点慢。

感谢社区论坛上的 OP 首先分享这个。

Answer 3

这里有一些命令可以快速清理您的工作流程。

您将需要xargs 、 gh和jq CLI 工具。

根据您运行的次数，您必须多次执行删除步骤，因为 GH API 端点是分页的。

OWNER=<your user/org name>
REPO=<repo name>

# list workflows
gh api -X GET /repos/$OWNER/$REPO/actions/workflows | jq '.workflows[] | .name,.id'

# copy the ID of the workflow you want to clear and set it
WORKFLOW_ID=<workflow id>

# list runs
gh api -X GET /repos/$OWNER/$REPO/actions/workflows/$WORKFLOW_ID/runs | jq '.workflow_runs[] | .id'

# delete runs (you'll have to run this multiple times if there's many because of pagination)
gh api -X GET /repos/$OWNER/$REPO/actions/workflows/$WORKFLOW_ID/runs | jq '.workflow_runs[] | .id' | xargs -I{} gh api -X DELETE /repos/$OWNER/$REPO/actions/runs/{}

Answer 4

根据@Giampaolo Rodolà 的回答（对我有用），我创建了这个简单的 shell 脚本来完成这项工作。

在执行此脚本之前禁用要删除的工作流（通过 Github 控制台）。

org=<your org>
repo=<your repo>

# Get workflow IDs with status "disabled_manually"
workflow_ids=($(gh api repos/$org/$repo/actions/workflows | jq '.workflows[] | select(.["state"] | contains("disabled_manually")) | .id'))

for workflow_id in "${workflow_ids[@]}"
do
  echo "Listing runs for the workflow ID $workflow_id"
  run_ids=( $(gh api repos/$org/$repo/actions/workflows/$workflow_id/runs --paginate | jq '.workflow_runs[].id') )
  for run_id in "${run_ids[@]}"
  do
    echo "Deleting Run ID $run_id"
    gh api repos/$org/$repo/actions/runs/$run_id -X DELETE >/dev/null
  done
done

结果：

Listing runs for the workflow ID 5261185
Deleting Run ID 507553125
Deleting Run ID 507548002
Listing runs for the workflow ID 5261568
Deleting Run ID 525274011
Deleting Run ID 525264327
Deleting Run ID 525247443

确保在 Github 中安装了 Github 客户端和所需的令牌权限。

Answer 5

我设法通过使用“gh” CLI 工具和阅读REST API 文档来解决这个问题（目前无法通过 UI）。

首先，获取所有工作流程（这些工作流程显示在 Web UI -> 操作 -> 左栏中）：

$ gh api repos/$YOUR_USER/$YOUR_REPO/actions/workflows
{
  "total_count": 2,
  "workflows": [
    {
      "id": 3611607,
      "name": "FreeBSD",
      ...
    },
    {
      "id": 4336318,
      "name": "MacOS",
      ...
    }
  ]
}

使用您要删除的工作流的 ID（例如 3611607）来获取其所有单独的运行：

$ gh api repos/$YOUR_USER/$YOUR_REPO/actions/workflows/3611607/runs
{
  "total_count": 17,
  "workflow_runs": [
    {
      "id": 363876785,
      "name": "FreeBSD",
      ...
    },
    {
      "id": 363876786,
      "name": "FreeBSD",
      ...
    },
    {
      "id": 363876787,
      "name": "FreeBSD",
      ...
    },
}

对于每个运行 ID（比如说 363876785），使用以下命令将其删除：

$ gh api repos/$YOUR_USER/$YOUR_REPO/actions/runs/363876785 -X DELETE

之后，Web UI 左栏中不可删除的 Action 应该会消失。

Answer 6

删除属于您的工作流程的所有工作，您的工作流程将消失

P/s：如果您有数千个作业要删除，那么使用 API 是一个很好的方法：https ://docs.github.com/en/rest/reference/actions#workflow-runs

Answer 7

在 GitHub 实现“删除所有工作流运行”之前，您必须依赖 API。 在工作站上安装 CLI 工具gh和jq后，您可以运行以下命令来删除该工作流的所有运行。 删除所有运行后，它将不再显示在 UI 中。

cd /path/to/your/repo

gh workflow list # Pick-up the workflow ID for which you want to delete all runs
WORKFLOW_ID=<the workflow id> # Change this line!

# List last 10 runs of the workflow you picked to double check the id
gh run list -L 10 -w $WORKFLOW_ID

# Some set up
REPO_INFO=$(gh repo view --json name,owner)
REPO_FULL_NAME="$(echo $REPO_INFO | jq '.owner.login' -r)/$(echo $REPO_INFO | jq '.name' -r)"

# Ready? Let's delete some runs!
gh api -X GET "/repos/$REPO_FULL_NAME/actions/workflows/$WORKFLOW_ID/runs?per_page=100" | jq '.workflow_runs[] | .id' -r | xargs -t -I{} gh api --silent -X DELETE /repos/$REPO_FULL_NAME/actions/runs/{}

最后一个命令将删除最后 100 次运行（来自 GitHub API 的限制）。 如果有更多，请多次运行以删除所有内容。

Answer 8

从某个工作流中删除所有运行

@Sheece Gardazi答案的改进版本，支持选择特定工作流程：

export OWNER="my-user"
export REPOSITORY="my-repo"
export WORKFLOW="My Workflow"

gh api -X GET /repos/$OWNER/$REPOSITORY/actions/runs --paginate \
  | jq '.workflow_runs[] | select(.name == '\"$WORKFLOW\"') | .id' \
  | xargs -I{} gh api -X DELETE /repos/$OWNER/$REPOSITORY/actions/runs/{}

它需要GitHub CLI ：

brew install gh
gh auth login

和jq ：

brew install jq

Answer 9

遵循 Github Actions 文档： https ://docs.github.com/en/actions/managing-workflow-runs/deleting-a-workflow-run

删除不再需要的workflow应该很容易，就像在这张图片中显示的那样

如果您没有看到delete option ，而是看到disable workflow ，那是因为该工作流仍然有一些workflow runs 。 您需要删除这些工作流程运行，然后会出现删除选项:)

Answer 10

还有一个 PowerShell 实现（感谢其他受访者），它也需要gh cli 。

$user = "your user"
$repo = "repo"

(gh api repos/$user/$repo/actions/runs | ConvertFrom-Json).workflow_runs |
 %{ $_.id } |
 %{ gh api repos/$user/$repo/actions/runs/$_ -X DELETE }

重新运行“单线”，直到没有更多； 它目前分页到 30 个结果。

Answer 11

我有 600 多个要删除的操作，因此有多个页面。 我必须在 for 循环中运行命令：

# install following packages 
sudo snap install jq gh
# To authenticate github cli
gh auth login

# for reference path to your code repository: https://github.com/$OWNER/$REPOSITORY
export OWNER=<OWNER_NAME/ORGANIZATIONS_NAME>
export REPOSITORY=<REPOSITORY_NAME>

# repeat command 30 times, if there are 30 pages of workflow history 
for i in {1..30}; do gh api -X GET /repos/$OWNER/$REPOSITORY/actions/runs | jq '.workflow_runs[] | .id' | xargs -I{} gh api -X DELETE /repos/$OWNER/$REPOSITORY/actions/runs/{}; done

Answer 12

尽管这篇文章中有所有答案，但我无法删除工作流程。对我有用的是，我首先使用“gh auth login”对自己进行了身份验证，然后使用以下命令获取您的工作流程的详细信息想删除。 如果您不知道工作流 ID，则只需运行“gh api repos/$org/$repo/actions/workflows/”即可查看所有工作流。 运行此程序后，您将知道需要从中删除工作流的分支。 在我们的例子中，工作流程存在于“开发”分支中。 您可以在“html_url”中看到这一点。 一旦我从开发分支中删除了工作流文件，工作流就从各处消失了。 此外，当您运行“gh api repos/$org/$repo/actions/workflows/$workflow_id”时，您会注意到状态将更改为“已删除”。

$> gh api repos/$org/$repo/actions/workflows/$workflow_id

{
  "id": 6,
  "node_id": "blah",
  "name": "Run Unit Tests",
  "path": ".github/workflows/unittests.yml",
  "state": "active",
  "created_at": "2021-05-15T00:25:19.000-07:00",
  "updated_at": "2022-03-10T13:02:43.000-08:00",
  "url": "blah",
  "html_url": "https://company-name/workspace/project/blob/develop/.github/workflows/unittests.yml",
  "badge_url": "blah"
}

Answer 13

对于任何想知道的人，删除.github/workflows中的workflow.yml文件是可行的，但您需要确保在所有分支中都将其删除。 如果master/main仍然有工作流文件，那么 GitHub 将保留它们。

Answer 14

删除所有相关的工作流程运行后，它应该会自动删除。

Answer 15

就我而言，删除通过 CLI 运行的工作流只是解决方案的一部分。 GitHub 仍然拒绝显示我之后尝试再次添加的任何工作流程。

我通过使用 GH 中的“新工作流程”按钮并从模板创建工作流程来解决它。 我粘贴了原始 YML 文件的内容并重命名了该文件，以使一切看起来像以前一样。 最后，我通过网络提交——GitHub 再次展示了我的工作流程。

Answer 16

这是另一个使用Ritchie CLI自动从 Github 操作工作流中删除所有日志的选项。

您需要做的就是：

• 运行rit github delete workflow-logs
• 告知你的github 用户名和令牌
• 通知回购所有者和名称
• 选择要清理的 repo 工作流程

可以在这里看到一个例子。 请注意，您需要使用 Ritchie CLI 工具导入此存储库才能使命令正常工作。

Answer 17

1. 安装 Ritchie CLI： https ://docs.ritchiecli.io/

2. 运行rit add repo

? Select your provider: Github
? Repository name: formulas-github
? Repository URL: https://github.com/GuillaumeFalourd/formulas-github
? Is a private repository? no
? Select a tag version: {latest}
? Set the priority: 1

3. 运行rit set formula-runner

? Select a default formula run type: docker
The default formula runner has been successfully configured!

4. 启动 Docker 桌面

5. 转到https://github.com/settings/tokens ，添加生成 GitHub 个人访问令牌（使用“工作流”范围）

6. 运行rit github delete workflow-logs

7. 输入您的 GitHub 用户名、GitHub 令牌、GitHub 所有者、GitHub 存储库名称，然后选择您希望删除运行的工作流🙌

8. 撤销您的PAT

Answer 18

我创建了这个命令行工具来方便地选择多个条目并将它们从可导航列表中一起删除：

https://github.com/jv-k/delete-workflow-runs

Answer 19

我对@david-miguel的回答做了一些小的调整，将过滤卸载到github的api，而不是在本地进行。

#!/bin/sh

OWNER="user-name|org-name"
REPOSITORY="repository-name"
WORKFLOW="workflow-human-friendly-name"

gh run list --repo "$OWNER/$REPOSITORY" -w "$WORKFLOW" --json databaseId \
    | jq '.[].databaseId' \
    | xargs -I{} gh api -X DELETE /repos/$OWNER/$REPOSITORY/actions/runs/{}

Answer 20

对于删除工作流且无法删除工作流运行 (404) 的人？

找到这个帖子后，我仍然花了相当长的时间让我的工作流程逐渐消失......

@ribeiro 提供的答案是正确的，但是对于已删除其工作流程的人，他们将无法删除运行，它将解析为 404！

如何删除不再有工作流的工作流运行我尝试了很多事情，最后，只有这对我有用：

1. 对于您删除的每个工作流，创建与前一个同名的 yml 文件（ filename.yml和工作流中的 name 属性必须与前一个相同）。 这样 github 会将它们视为“现有”。
2. 创建 a.sh 文件并输入以下内容（我将使用 Ribeiro 提供的答案，但是，我将删除 state 过滤器，因为我希望将它们全部删除）

OWNER="aOwner"
REPO="aRepo"

workflow_ids=($(gh api repos/$OWNER/$REPO/actions/workflows | jq '.workflows[] | .id'))

for workflow_id in "${workflow_ids[@]}"
do
 echo "Listing runs for the workflow ID $workflow_id"
 run_ids=( $(gh api repos/$OWNER/$REPO/actions/workflows/$workflow_id/runs --paginate | jq '.workflow_runs[].id') )
 for run_id in "${run_ids[@]}"
 do
   echo "Deleting Run ID $run_id"
   gh api repos/$OWNER/$REPO/actions/runs/$run_id -X DELETE >/dev/null
 done
done

4. 运行 .sh 文件。 您应该会看到已删除运行的工作流程（确实需要一些时间）

Answer 21

截至 2022 年 12 月 31 日，假设您有一个工作流.github/workflows/test.yml 。

删除此工作流文件并合并到主分支后，侧面菜单上的工作流以及所有工作流运行历史记录都将消失。

您可以通过手动 go 验证到旧的工作流程链接https://github.com/[username]/[repo]/actions/workflows/test.yml

这是目前的结果。

Answer 22

这是一个仅使用 GitHub CLI 的答案（您需要安装并验证 re: https://github.com/cli/cli#installation ）和 awk：

OWNER="repoOwner"
REPO="repoName"

gh run list --repo <[HOST/]OWNER/REPO> -workflow <string> | \
  awk -F '\t' '{ if ($2 == "failure") { print $7 } }' | \
  while read id; do gh api repos/$OWNER/$REPO/runs/$id -X DELETE; done

Answer 23

更新您的本地分支以与 master 同步，然后删除 github/workflows。 提交并推送您的更改。 应在 master 中删除 Wokflow

Answer 24

我确实找到了这样做的方法。 您可以转到.github/workflows或设置工作流的任何位置，然后提交删除文件（工作流文件） ，最终将其删除。

Answer 25

如果要删除多个工作流运行，则应使用 GitHub Action API 获取要删除的运行 ID，然后发送带有包含个人访问令牌的标头的 DELETE 请求以删除工作流运行。
试试这个 python 脚本来删除所有工作流运行。
https://github.com/wh201906/garage/blob/master/Python/DeleteGithubAction/delete.py
它使用 grequests 一次发出多个请求，并且此脚本不需要 gh 和 jq。

Answer 26

您的工作流程是 *.yml 文件保存在文件夹 /.github/workflows/ 中的存储库中

只需删除它们！

Answer 27

我尝试从这个位置 .github/workflows/ 删除 yml 文件，它就像一个魅力。

Answer 28

您可以从 github 的 Code 选项卡中删除该文件，因为它是作为普通提交添加的

单击文件，然后单击删除图标：