cleanup-workflows.yml

#
# .github/workflows/cleanup-workflows.yml
#
# Copyright 2021 Ching Chow, Jens A. Koch.
# SPDX-License-Identifier: BSL-1.0
# Origin: https://github.community/t/delete-old-workflow-results/16152/42
# This file is part of https://github.com/jakoch/csgo-cli
#

name: Clean Workflow Runs

on:
  # This workflow runs at 00:00 daily.
  schedule:
  - cron: '0 0 * * *'  # GMT
  # You can manually run this workflow.
  workflow_dispatch:

jobs:

# ---------------------------------------------------------------------------------------

  cleanup-workflows:

# ---------------------------------------------------------------------------------------

    name: "Clean Workflows"
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
    - name: ✂ Remove cancelled or skipped workflow runs
      uses: actions/github-script@v7 # https://github.com/actions/github-script
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        script: |
          const cancelled = await github.rest.actions.listWorkflowRunsForRepo({
            owner: context.repo.owner,
            per_page: 100,
            repo: context.repo.repo,
            status: 'cancelled',
          });
          const skipped = await github.rest.actions.listWorkflowRunsForRepo({
            owner: context.repo.owner,
            per_page: 100,
            repo: context.repo.repo,
            status: 'skipped',
          });
          for (const response of [cancelled, skipped]) {
            for (const run of response.data.workflow_runs) {
              console.log(`[Deleting] Run id ${run.id} of '${run.name}' is a cancelled or skipped run.`);
              await github.rest.actions.deleteWorkflowRun({
                owner: context.repo.owner,
                repo: context.repo.repo,
                run_id: run.id
              });
            }
          }

    - name: ✂ Remove 30 days old workflows runs
      uses: actions/github-script@v7 # https://github.com/actions/github-script
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        script: |
          const days_to_expiration = 14;
          const ms_in_day = 86400000;
          const now = Date.now();
          const pages = 5;
          // add the workflows runs to remove here
          const workflows = [
            'build.yml',
            'publish-PR-test-results.yml'            
          ]
          let runs_to_delete = [];
          for (const workflow of workflows) {
            for (let page = 0; page < pages; page += 1) {
              let response = await github.rest.actions.listWorkflowRuns({
                owner: context.repo.owner,
                page: page,
                per_page: 100,
                repo: context.repo.repo,
                workflow_id: workflow
              });
              if (response.data.workflow_runs.length > 0) {
                for (const run of response.data.workflow_runs) {
                  if (now - Date.parse(run.created_at) > ms_in_day * days_to_expiration) {
                    runs_to_delete.push([run.id, run.name]);
                  }
                }
              }
            }
          }
          for (const run of runs_to_delete) {
            console.log(`[Deleting] Run id ${run[0]} of '${run[1]}' is older than ${days_to_expiration} days.`);
            try {
              await github.rest.actions.deleteWorkflowRun({
                owner: context.repo.owner,
                repo: context.repo.repo,
                run_id: run[0]
              });
            } catch (error) {
              // ignore errors
            }
          }

    - name: ✂ Remove runs of the cleanup workflow itself
      uses: actions/github-script@v7 # https://github.com/actions/github-script
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        script: |
          const pages = 5;
          let runs_to_delete = [];
          for (let page = 0; page < pages; page += 1) {
            let response = await github.rest.actions.listWorkflowRuns({
              owner: context.repo.owner,
              page: page,
              per_page: 100,
              repo: context.repo.repo,
              workflow_id: 'cleanup-workflows.yml'
            });
            if (response.data.workflow_runs.length > 0) {
              for (const run of response.data.workflow_runs) {
                  runs_to_delete.push([run.id, run.name]);
              }
            }
          }
          for (const run of runs_to_delete) {
            console.log(`[Deleting] Run id ${run[0]} of '${run[1]}'.`);
            try {
              await github.actions.deleteWorkflowRun({
                owner: context.repo.owner,
                repo: context.repo.repo,
                run_id: run[0]
              });
            } catch (error) {
              // ignore errors
            }
          }