feat: allow for pruning of older PRs

README.md

@@ -232,24 +232,25 @@ jobs:
 
 ### Configuration parameters
 
-| Variable | Description | Required | `[Default]` |
-|----|----|----|----|
-| github_token | Token for the repo. Can be passed in using `$\{{ secrets.GITHUB_TOKEN }}` | `true` | |
-| source_repo_path | Repository path of the template | `true` | |
-| upstream_branch | The target branch | `false` | `<The_remote_default>` |
-| source_repo_ssh_private_key | `[optional]` private ssh key for the source repository. [see](#private-template-repository)| `false` | |
-| pr_branch_name_prefix | `[optional]` the prefix of branches created by this action | `false` | `chore/template_sync` |
-| pr_title | `[optional]` the title of PRs opened by this action. Must be already created. | `false` | `upstream merge template repository` |
-| pr_labels | `[optional]` comma separated list. [pull request labels][pr-labels]. Must be already created. | `false` | |
-| pr_reviewers | `[optional]` comma separated list of pull request reviewers. | `false` | |
-| pr_commit_msg | `[optional]` commit message in the created pull request | `false` | `chore(template): merge template changes :up:` |
-| hostname | `[optional]` the hostname of the repository | `false` | `github.com` |
-| is_dry_run | `[optional]` set to `true` if you do not want to push the changes and not want to create a PR | `false` | |
-| is_allow_hooks | `[optional]` set to `true` if you want to enable lifecycle hooks. Use this with caution! | `false` | `false` |
-| is_not_source_github | `[optional]` set to `true` if the source git provider is not GitHub | `false` | `false` |
-| git_user_name | `[optional]` set the committer git user.name | `false` | `${GITHUB_ACTOR}` |
-| git_user_email | `[optional]` set the committer git user.email | `false` | `github-action@actions-template-sync.noreply.${SOURCE_REPO_HOSTNAME}` |
-| git_remote_pull_params |`[optional]` set remote pull parameters | `false` | `--allow-unrelated-histories --squash --strategy=recursive -X theirs` |
+| Variable | Description | Required | `[Default]` |
+|-----------------------------|---------------------------------------------------------------------------------------------------------------|----------|-----------------------------------------------------------------------|
+| github_token | Token for the repo. Can be passed in using `$\{{ secrets.GITHUB_TOKEN }}` | `true` | |
+| source_repo_path | Repository path of the template | `true` | |
+| upstream_branch | The target branch | `false` | `<The_remote_default>` |
+| source_repo_ssh_private_key | `[optional]` private ssh key for the source repository. [see](#private-template-repository) | `false` | |
+| pr_branch_name_prefix | `[optional]` the prefix of branches created by this action | `false` | `chore/template_sync` |
+| pr_title | `[optional]` the title of PRs opened by this action. Must be already created. | `false` | `upstream merge template repository` |
+| pr_labels | `[optional]` comma separated list. [pull request labels][pr-labels]. Must be already created. | `false` | |
+| pr_reviewers | `[optional]` comma separated list of pull request reviewers. | `false` | |
+| pr_commit_msg | `[optional]` commit message in the created pull request | `false` | `chore(template): merge template changes :up:` |
+| hostname | `[optional]` the hostname of the repository | `false` | `github.com` |
+| is_dry_run | `[optional]` set to `true` if you do not want to push the changes and not want to create a PR | `false` | |
+| is_allow_hooks | `[optional]` set to `true` if you want to enable lifecycle hooks. Use this with caution! | `false` | `false` |
+| is_pr_cleanup | `[optional]` set to `true` if you want to cleanup older PRs targeting the same branch. Use this with caution! | `false` | `false` |
+| is_not_source_github | `[optional]` set to `true` if the source git provider is not GitHub | `false` | `false` |
+| git_user_name | `[optional]` set the committer git user.name | `false` | `${GITHUB_ACTOR}` |
+| git_user_email | `[optional]` set the committer git user.email | `false` | `github-action@actions-template-sync.noreply.${SOURCE_REPO_HOSTNAME}` |
+| git_remote_pull_params | `[optional]` set remote pull parameters | `false` | `--allow-unrelated-histories --squash --strategy=recursive -X theirs` |
 
 ### Docker
 
@@ -304,6 +305,7 @@ The following hooks are supported (please check [docs/ARCHITECTURE.md](docs/ARCH
 * `prepull` is executed before the code is pulled from the source repository
 * `precommit` is executed before the code is commited
 * `prepush` is executed before the push is executed, right after the commit
+* `precleanup` is executed before older PRs targeting the same branch are closed
 * `prepr` is executed before the PR is done
 
 **Remark** The underlying OS is defined by an Alpine container.
@@ -329,6 +331,10 @@ hooks:
  commands:
  - echo 'hi, we are within the prepush phase'
  - echo 'maybe you want to add further changes and commits'
+ precleanup:
+ commands:
+ - echo 'hi, we are within the precleanup phase'
+ - echo 'maybe you want to interact with older PRs before they are closed'
  prepr:
  commands:
  - echo 'hi, we are within the prepr phase'

action.yml

@@ -36,6 +36,9 @@ inputs:
  is_allow_hooks:
  description: "[optional] set to true if you want to allow hooks. Use this functionality with caution!"
  default: "false"
+ is_pr_cleanup:
+ description: "[optional] set to true if you want to cleanup older PRs targeting the same branch."
+ default: "false"
  is_not_source_github:
  description: "[optional] set to true if the source repository is not a github related repository. Useful e.q. if the source is GitLab"
  default: "false"
@@ -61,6 +64,7 @@ runs:
  HOSTNAME: ${{ inputs.hostname }}
  IS_DRY_RUN: ${{ inputs.is_dry_run }}
  IS_ALLOW_HOOKS: ${{ inputs.is_allow_hooks }}
+ IS_PR_CLEANUP: ${{ inputs.is_pr_cleanup}}
  IS_NOT_SOURCE_GITHUB: ${{ inputs.is_not_source_github }}
  GIT_USER_NAME: ${{ inputs.git_user_name }}
  GIT_USER_EMAIL: ${{ inputs.git_user_email }}

src/sync_template.sh

@@ -121,10 +121,33 @@ git commit -m "${PR_COMMIT_MSG}"
 
 echo "::endgroup::"
 
+cleanup_older_prs () {
+ cmd_from_yml_file "precleanup"
+
+ if [ "$IS_DRY_RUN" != "true" ]; then
+ echo "::group::cleanup older PRs"
+ gh pr list \
+ --base "${UPSTREAM_BRANCH}" \
+ --state open \
+ --label "${PR_LABELS}" \
+ --json number \
+ --template '{{range .}}{{printf "%v" .number}}{{"\n"}}{{end}}' | xargs -L1 gh pr close
+ echo "::endgroup::"
+ else
+ warn "dry_run option is set to off. Skipping older prs cleanup"
+ fi
+}
+
+if [ "$IS_PR_CLEANUP" != "false" ]; then
+ cleanup_older_prs
+else
+ warn "is_pr_cleanup option is set to off. Skipping older prs cleanup"
+fi
+
 push_and_create_pr () {
  cmd_from_yml_file "prepush"
- if [ "$IS_DRY_RUN" != "true" ]; then
 
+ if [ "$IS_DRY_RUN" != "true" ]; then
  echo "::group::push changes and create PR"
  debug "push changes"
  git push --set-upstream origin "${NEW_BRANCH}"