Skip to content

feat(cleanup-branches): add exclude-patterns input #1972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ldufr wants to merge 1 commit into
base: main
Choose a base branch
from
+29 −5
Open

feat(cleanup-branches): add exclude-patterns input #1972

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions actions/cleanup-branches/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ Composite action (step) to query for branches that are not in an open PR, and de

## Inputs

| Name | Type | Description | Default Value | Required |
| ---------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | -------- |
| `token` | `string` | GitHub token used to authenticate with `gh`. Requires permission to query for protected branches and delete branches (`contents: write`) and pull requests (`pull_requests: read`) | `${{ github.token }}` | true |
| `dry-run` | `bool` | If `'true'`, then the action will print branches to be deleted, but will not delete them | `'true'` | true |
| `max-date` | `string` | Value passed to `date -d`; a human readable date string. Maximum date of the head ref of a branch in order to be deleted. | `"2 weeks ago"` | false |
| Name | Type | Description | Default Value | Required |
| ------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | -------- |
| `token` | `string` | GitHub token used to authenticate with `gh`. Requires permission to query for protected branches and delete branches (`contents: write`) and pull requests (`pull_requests: read`) | `${{ github.token }}` | true |
| `dry-run` | `bool` | If `'true'`, then the action will print branches to be deleted, but will not delete them | `'true'` | true |
| `max-date` | `string` | Value passed to `date -d`; a human readable date string. Maximum date of the head ref of a branch in order to be deleted. | `"3 months ago"` | false |
| `exclude-patterns` | `string` | Newline-separated list of glob patterns. Branches whose names match any pattern are excluded from deletion. Empty lines are ignored. | `""` | false |

## Examples

Expand All @@ -33,6 +34,8 @@ jobs:
- uses: grafana/shared-workflows/actions/cleanup-branches@cleanup-branches/v0.2.1
with:
dry-run: false
exclude-patterns: |
release/*
```

<!-- x-release-please-end-version -->
21 changes: 21 additions & 0 deletions actions/cleanup-branches/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ inputs:
Value provided to `date -d={}. From `man date`: "The --date=STRING is a mostly free format human readable date string such as "Sun, 29 Feb 2004 16:21:42 -0800" or "2004-02-29 16:21:42" or even "next Thursday". A date string may
contain items indicating calendar date, time of day, time zone, day of week, relative time, relative date, and numbers. An empty string indicates the beginning of the day. The
date string format is more complex than is easily documented here but is fully described in the info documentation."
exclude-patterns:
default: ""
description: |
Optional list of glob patterns. Branches whose names match any pattern are excluded
from deletion. Patterns use bash glob syntax (e.g. `release/*`).
runs:
using: composite
steps:
Expand All @@ -24,6 +29,7 @@ runs:
GH_TOKEN: ${{ inputs.token }}
DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
MAX_DATE: ${{ inputs.max-date }}
EXCLUDE_PATTERNS: ${{ inputs.exclude-patterns }}
run: |
#!/usr/bin/env bash
# Fetch all branches from remote. This is basically `git fetch --unshallow` but also fetches branches.
Expand All @@ -35,6 +41,12 @@ runs:
# For repositories that have exceeded 2,000+ branches, this could fail.
readarray -t protected_branches < <(gh api --paginate "/repos/${GITHUB_REPOSITORY}/branches?protected=true" | jq -cr '.[].name')

exclude_patterns=()
while IFS= read -r line; do
line="${line%$'\r'}"
[[ -n "$line" ]] && exclude_patterns+=("$line")
done <<< "$EXCLUDE_PATTERNS"

branches=()
while IFS= read -r line; do
branches+=("$line")
Expand All @@ -57,6 +69,15 @@ runs:
fi
done
fi
if [ "$found" != 1 ]; then
for pattern in "${exclude_patterns[@]}"; do
# Unquoted RHS so bash treats $pattern as a glob.
if [[ "$branch" == $pattern ]]; then
found=1
break
fi
done
fi
if [ "$found" != 1 ]; then
to_delete+=("$branch")
fi
Expand Down
Loading