github auto delete branch after merge

HaC 2025

2 min read

·

25-10-2024

44

0

Share

Automating Your Workflow: Deleting Branches After Merge on GitHub

Keeping your GitHub repository organized and clean is crucial for efficient collaboration. One way to achieve this is by automatically deleting branches after they've been merged into the main branch. This practice prevents clutter and makes it easier to track active development. Let's explore how to implement this workflow using GitHub features.

Why Automate Branch Deletion?

Here's why auto-deleting branches after merging is a good idea:

• Reduced Clutter: A cluttered branch list makes it harder to find the branch you need. Auto-deletion keeps things clean and organized.
• Improved Visibility: By removing inactive branches, you make the list of branches more relevant and focused on active development.
• Consistent Workflow: Automating this task eliminates the manual step of deleting branches, creating a streamlined workflow for everyone.

Implementing Branch Deletion with GitHub Actions

GitHub Actions offer a powerful way to automate tasks within your repository, including branch deletion. Here's how to set it up:

1. Create a Workflow File:

Navigate to your repository on GitHub and select Actions. Click on "Set up a workflow yourself" to create a new workflow file.

2. Define the Workflow:

name: Delete branch after merge

on:
  push:
    branches:
      - main

jobs:
  delete-branch:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout code
      uses: actions/checkout@v3
    - name: Delete branch
      uses: actions/delete-branch@v3
      with:
        ref: ${{ github.head_ref }}
        token: ${{ secrets.GITHUB_TOKEN }}

3. Explanation:

• name: This defines the name of the workflow.
• on: This specifies the event that triggers the workflow. In this case, it's triggered when a push occurs to the main branch.
• jobs: Defines the tasks to be executed within the workflow.
• delete-branch: The name of the job.
• runs-on: The operating system used to run the job.
• steps: Each step within the job.
  • Checkout code: Checks out the repository code.
  • Delete branch: Deletes the branch using the actions/delete-branch action.
    • ref: Specifies the branch to be deleted (using the github.head_ref context variable, which contains the branch name that was just merged).
    • token: Uses the GITHUB_TOKEN secret to provide authentication.

4. Commit and Push the Workflow File:

Commit the workflow file to your repository. Now, whenever you merge a pull request to the main branch, GitHub Actions will automatically delete the branch.

5. Important Considerations:

• Access and Permissions: Ensure that the GitHub Action has the necessary permissions to delete branches.
• Branch Protection Rules: If you have branch protection rules in place, adjust them to allow the action to delete branches.
• Branch Naming Conventions: The workflow assumes you are using the main branch. You may need to adjust the branches definition if you have a different branch name.

Advanced Options

• Conditional Branch Deletion: You can customize the workflow to delete branches only under specific conditions, such as only deleting branches that are in a specific state (e.g., merged).
• Customizing Deletion Message: You can add a custom message when the branch is deleted.
• Deleting Multiple Branches: You can modify the workflow to delete multiple branches based on certain criteria.

Conclusion

Automating branch deletion after merging not only simplifies your workflow but also promotes a cleaner and more efficient development environment. By leveraging GitHub Actions, you can easily implement this feature, streamlining your development practices and keeping your repository in top shape.