https://github.com/josiahsiegel/workflow-housekeeper

Retain a time period or quantity of workflow runs.
https://github.com/josiahsiegel/workflow-housekeeper

Last synced: 6 days ago
JSON representation

Retain a time period or quantity of workflow runs.

• Host: GitHub
• URL: https://github.com/josiahsiegel/workflow-housekeeper
• Owner: JosiahSiegel
• Created: 2023-04-04T18:53:44.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-01T12:02:00.000Z (7 months ago)
• Last Synced: 2024-10-06T16:17:22.869Z (about 1 month ago)
• Language: Shell
• Homepage:
• Size: 21.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Workflow Housekeeper

Retain a time period or quantity of workflow runs.

[![Test action](https://github.com/JosiahSiegel/workflow-housekeeper/actions/workflows/test_action.yml/badge.svg)](https://github.com/JosiahSiegel/workflow-housekeeper/actions/workflows/test_action.yml)

### Dependencies:

>Change in repo: `Settings -> Actions -> General -> Workflow Permissions to allow read and write`

## Inputs

```yml

  ignore-branch-workflows:

    description: 'Ignore runs from workflows currently in ./github/workflow'

    required: false

  retention-time:

    description: 'Period of time to maintain history. E.g. "2 weeks", "3 days", etc.'

    required: false

  retain-run-count:

    description: 'Number of latest runs to keep'

    required: false

  dry-run:

    description: 'Only list runs pending deletion'

    required: false

```

## Usage

```yml

      - name: Checkout

        uses: actions/checkout@v3

      - name: Run workflow housekeeper

        uses: josiahsiegel/workflow-housekeeper@

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

or

```yml

      - name: Checkout

        uses: actions/checkout@v3

      - name: Run workflow housekeeper

        uses: josiahsiegel/workflow-housekeeper@

        id: scan

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

        with:

          ignore-branch-workflows: true

          retention-time: '1 days'

          retain-run-count: 1

          dry-run: false

```

## Generated summary

### ✨ Workflow Housekeeper ✨

  * .github/workflows/test_action.yml 4618840926

  * .github/workflows/test_action.yml 4618827035