Skip to content

scripts: de-duplicate and harden the close_pull_requests_with_*.sh backlog jobs #15169

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

Closed
priya-sundaram-dev wants to merge 1 commit into from
Closed

scripts: de-duplicate and harden the close_pull_requests_with_*.sh backlog jobs #15169

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
27 changes: 6 additions & 21 deletions scripts/close_pull_requests_with_awaiting_changes.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,7 @@
#!/bin/bash

# List all open pull requests
prs=$(gh pr list --state open --json number,title,labels --limit 500)

# Loop through each pull request
echo "$prs" | jq -c '.[]' | while read -r pr; do
pr_number=$(echo "$pr" | jq -r '.number')
pr_title=$(echo "$pr" | jq -r '.title')
pr_labels=$(echo "$pr" | jq -r '.labels')

# Check if the "awaiting changes" label is present
awaiting_changes=$(echo "$pr_labels" | jq -r '.[] | select(.name == "awaiting changes")')
echo "Checking PR #$pr_number $pr_title ($awaiting_changes) ($pr_labels)"

# If awaiting_changes, close the pull request
if [[ -n "$awaiting_changes" ]]; then
echo "Closing PR #$pr_number $pr_title due to awaiting_changes label"
gh pr close "$pr_number" --comment "Closing awaiting_changes PRs to prepare for Hacktoberfest"
sleep 2
fi
done
#
# Close every open pull request labelled "awaiting changes".
# Thin wrapper around close_pull_requests_with_label.sh so all five backlog
# jobs share one implementation. Set DRY_RUN=1 to preview.
set -euo pipefail
exec "$(dirname "$0")/close_pull_requests_with_label.sh" "awaiting changes" "$@"
27 changes: 6 additions & 21 deletions scripts/close_pull_requests_with_failing_tests.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,7 @@
#!/bin/bash

# List all open pull requests
prs=$(gh pr list --state open --json number,title,labels --limit 500)

# Loop through each pull request
echo "$prs" | jq -c '.[]' | while read -r pr; do
pr_number=$(echo "$pr" | jq -r '.number')
pr_title=$(echo "$pr" | jq -r '.title')
pr_labels=$(echo "$pr" | jq -r '.labels')

# Check if the "tests are failing" label is present
tests_are_failing=$(echo "$pr_labels" | jq -r '.[] | select(.name == "tests are failing")')
echo "Checking PR #$pr_number $pr_title ($tests_are_failing) ($pr_labels)"

# If there are failing tests, close the pull request
if [[ -n "$tests_are_failing" ]]; then
echo "Closing PR #$pr_number $pr_title due to tests_are_failing label"
gh pr close "$pr_number" --comment "Closing tests_are_failing PRs to prepare for Hacktoberfest"
sleep 2
fi
done
#
# Close every open pull request labelled "tests are failing".
# Thin wrapper around close_pull_requests_with_label.sh so all five backlog
# jobs share one implementation. Set DRY_RUN=1 to preview.
set -euo pipefail
exec "$(dirname "$0")/close_pull_requests_with_label.sh" "tests are failing" "$@"
63 changes: 63 additions & 0 deletions scripts/close_pull_requests_with_label.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
#!/bin/bash
#
# Close every open pull request that carries a given label, leaving an
# explanatory comment. This is used to clear the backlog before Hacktoberfest.
#
# Usage:
# scripts/close_pull_requests_with_label.sh "<label>" ["<comment>"]
#
# Examples:
# scripts/close_pull_requests_with_label.sh "require type hints"
# DRY_RUN=1 scripts/close_pull_requests_with_label.sh "tests are failing"
#
# Environment variables:
# DRY_RUN=1 Print the PRs that would be closed without closing them.
# REPO Target repository (default: TheAlgorithms/Python).
# SLEEP Seconds to wait between closes (default: 2) to avoid tripping
# GitHub's secondary rate limits during bulk closes.
#
# On completion the script prints a machine-readable summary line:
# CLOSED_COUNT=<n> CLOSED_PRS=<comma-separated PR numbers>
# so the Hacktoberfest tracker can be updated from the output.

set -euo pipefail

label="${1:-}"
if [[ -z "$label" ]]; then
echo "error: missing label argument" >&2
echo "usage: $0 \"<label>\" [\"<comment>\"]" >&2
exit 2
fi

repo="${REPO:-TheAlgorithms/Python}"
sleep_seconds="${SLEEP:-2}"
comment="${2:-Closing \"${label}\" PRs to prepare for Hacktoberfest}"

# Filter by label server-side so we never miss PRs beyond an arbitrary --limit
# cap (the repo can have ~900 open PRs). --limit is set high purely as a ceiling.
prs=$(gh pr list --repo "$repo" --state open --label "$label" \
--json number,title --limit 1000)

count=$(echo "$prs" | jq 'length')
echo "Found $count open PR(s) with label \"$label\" in $repo"

closed=()
while read -r pr; do
[[ -z "$pr" ]] && continue
pr_number=$(echo "$pr" | jq -r '.number')
pr_title=$(echo "$pr" | jq -r '.title')

if [[ "${DRY_RUN:-0}" == "1" ]]; then
echo "[dry-run] would close PR #$pr_number: $pr_title"
closed+=("$pr_number")
continue
fi

echo "Closing PR #$pr_number: $pr_title"
gh pr close "$pr_number" --repo "$repo" --comment "$comment"
closed+=("$pr_number")
sleep "$sleep_seconds"
done < <(echo "$prs" | jq -c '.[]')

# Machine-readable summary for the tracker.
IFS=,; echo "CLOSED_COUNT=${#closed[@]} CLOSED_PRS=${closed[*]:-}"
26 changes: 6 additions & 20 deletions scripts/close_pull_requests_with_require_descriptive_names.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,7 @@
#!/bin/bash

# List all open pull requests
prs=$(gh pr list --state open --json number,title,labels --limit 500)

# Loop through each pull request
echo "$prs" | jq -c '.[]' | while read -r pr; do
pr_number=$(echo "$pr" | jq -r '.number')
pr_title=$(echo "$pr" | jq -r '.title')
pr_labels=$(echo "$pr" | jq -r '.labels')

# Check if the "require descriptive names" label is present
require_descriptive_names=$(echo "$pr_labels" | jq -r '.[] | select(.name == "require descriptive names")')
echo "Checking PR #$pr_number $pr_title ($require_descriptive_names) ($pr_labels)"

# If there are require_descriptive_names, close the pull request
if [[ -n "$require_descriptive_names" ]]; then
echo "Closing PR #$pr_number $pr_title due to require_descriptive_names label"
gh pr close "$pr_number" --comment "Closing require_descriptive_names PRs to prepare for Hacktoberfest"
fi
done
#
# Close every open pull request labelled "require descriptive names".
# Thin wrapper around close_pull_requests_with_label.sh so all five backlog
# jobs share one implementation. Set DRY_RUN=1 to preview.
set -euo pipefail
exec "$(dirname "$0")/close_pull_requests_with_label.sh" "require descriptive names" "$@"
27 changes: 6 additions & 21 deletions scripts/close_pull_requests_with_require_tests.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,7 @@
#!/bin/bash

# List all open pull requests
prs=$(gh pr list --state open --json number,title,labels --limit 500)

# Loop through each pull request
echo "$prs" | jq -c '.[]' | while read -r pr; do
pr_number=$(echo "$pr" | jq -r '.number')
pr_title=$(echo "$pr" | jq -r '.title')
pr_labels=$(echo "$pr" | jq -r '.labels')

# Check if the "require_tests" label is present
require_tests=$(echo "$pr_labels" | jq -r '.[] | select(.name == "require tests")')
echo "Checking PR #$pr_number $pr_title ($require_tests) ($pr_labels)"

# If there require tests, close the pull request
if [[ -n "$require_tests" ]]; then
echo "Closing PR #$pr_number $pr_title due to require_tests label"
gh pr close "$pr_number" --comment "Closing require_tests PRs to prepare for Hacktoberfest"
# sleep 2
fi
done
#
# Close every open pull request labelled "require tests".
# Thin wrapper around close_pull_requests_with_label.sh so all five backlog
# jobs share one implementation. Set DRY_RUN=1 to preview.
set -euo pipefail
exec "$(dirname "$0")/close_pull_requests_with_label.sh" "require tests" "$@"
26 changes: 6 additions & 20 deletions scripts/close_pull_requests_with_require_type_hints.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,7 @@
#!/bin/bash

# List all open pull requests
prs=$(gh pr list --state open --json number,title,labels --limit 500)

# Loop through each pull request
echo "$prs" | jq -c '.[]' | while read -r pr; do
pr_number=$(echo "$pr" | jq -r '.number')
pr_title=$(echo "$pr" | jq -r '.title')
pr_labels=$(echo "$pr" | jq -r '.labels')

# Check if the "require type hints" label is present
require_type_hints=$(echo "$pr_labels" | jq -r '.[] | select(.name == "require type hints")')
echo "Checking PR #$pr_number $pr_title ($require_type_hints) ($pr_labels)"

# If require_type_hints, close the pull request
if [[ -n "$require_type_hints" ]]; then
echo "Closing PR #$pr_number $pr_title due to require_type_hints label"
gh pr close "$pr_number" --comment "Closing require_type_hints PRs to prepare for Hacktoberfest"
fi
done
#
# Close every open pull request labelled "require type hints".
# Thin wrapper around close_pull_requests_with_label.sh so all five backlog
# jobs share one implementation. Set DRY_RUN=1 to preview.
set -euo pipefail
exec "$(dirname "$0")/close_pull_requests_with_label.sh" "require type hints" "$@"