https://github.com/not-an-aardvark/git-delete-squashed

Delete branches that have been squashed and merged into main
https://github.com/not-an-aardvark/git-delete-squashed

git

Last synced: 7 days ago
JSON representation

Delete branches that have been squashed and merged into main

• Host: GitHub
• URL: https://github.com/not-an-aardvark/git-delete-squashed
• Owner: not-an-aardvark
• License: mit
• Created: 2017-03-30T05:30:58.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-10-06T00:21:44.000Z (about 1 year ago)
• Last Synced: 2024-05-16T14:44:37.361Z (6 months ago)
• Topics: git
• Language: JavaScript
• Homepage:
• Size: 24.4 KB
• Stars: 431
• Watchers: 11
• Forks: 26
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# git-delete-squashed

This is a tool that deletes all of your git branches that have been "squash-merged" into master.

This is useful if you work on a project that squashes branches into master. After your branch is squashed and merged, you can use this tool to clean up the local branch.

## Usage

### sh

To run as a shellscript, simply copy the following command (setting up an alias is recommended). There's no need to clone the repo.

```bash

# Change $TARGET_BRANCH to your targeted branch, e.g. change from `master` to `main` to delete branches squashed into `main`.

TARGET_BRANCH=master && git checkout -q $TARGET_BRANCH && git for-each-ref refs/heads/ "--format=%(refname:short)" | while read branch; do mergeBase=$(git merge-base $TARGET_BRANCH $branch) && [[ $(git cherry $TARGET_BRANCH $(git commit-tree $(git rev-parse $branch\^{tree}) -p $mergeBase -m _)) == "-"* ]] && git branch -D $branch; done

# OR you can put this function in a global git alias and call it like this

# `git delete-squashed` OR `git delete-squashed main`

git config --global alias.delete-squashed '!f() { local targetBranch=${1:-master} && git checkout -q $targetBranch && git branch --merged | grep -v "\*" | xargs -n 1 git branch -d && git for-each-ref refs/heads/ "--format=%(refname:short)" | while read branch; do mergeBase=$(git merge-base $targetBranch $branch) && [[ $(git cherry $targetBranch $(git commit-tree $(git rev-parse $branch^{tree}) -p $mergeBase -m _)) == "-"* ]] && git branch -D $branch; done; }; f'

```

### Node.js

You can also install the tool as a Node.js package from NPM. (The package code is in this repo.)

Additionally, you can specify an alternate branch to check for squashed merges, as well. This is useful for different names of trunk branches like `main` or `develop`.

```bash

$ npm install --global git-delete-squashed

$ git-delete-squashed

$ # Specify a different branch name like so

$ git-delete-squashed main

```

## Details

To determine if a branch is squash-merged, git-delete-squashed creates a temporary dangling squashed commit with [`git commit-tree`](https://git-scm.com/docs/git-commit-tree). Then it uses [`git cherry`](https://git-scm.com/docs/git-cherry) to check if the squashed commit has already been applied to `master`. If so, it deletes the branch.