git-sweep-merged-and-stale 1.0b1
Clean up branches from your Git remotes
License: MIT
Keywords: git maintenance branches merge stale

git-sweep-merged-and-stale
===========================

This is based on the excellent `git-sweep`_ .

I just added ``delete_stale_after_days`` which allows you to specify ``delete_stale_after_days`` stale branches we need to delete.

ie: ``git-sweep-merged-and-stale cleanup --delete_stale_after_days 15`` will delete all Branches older than 15 days and those merged in Master.

WARNING: When you delete branches with no active PR, you will lose access to the ability to restore the branch. Please back it up using Github Artifacts or
a copy of the branch prior to running this.

This deletes branches that fulfil either of these:
  - Merged into Master or the branch you specify by ``which_master_main`` OR
  - Branches older than X days (specified by ``delete_stale_after_days``)

This by default does not work until you set parameter action = `cleanup`

To install it run:

::

    pip install git-sweep-merged-and-stale || easy_install git-sweep-merged-and-stale

Then to run it in ``preview`` mode:

::

   git-sweep-merged-and-stale preview --delete_stale_after_days 30

Then to run it in ``cleanup`` mode:

::

   git-sweep-merged-and-stale cleanup --delete_stale_after_days 30

Introduction
------------

A command-line tool that helps you clean up Git branches that have been merged
into master.

One of the best features of Git is cheap branches. There are existing branching
models like `GitHub Flow`_ and Vincent Driessen's `git-flow`_ that describe
methods for using this feature.

The problem
-----------

Your ``master`` branch is typically where all your code lands. All features
branches are meant to be short-lived and merged into ``master`` once they are
completed.

As time marches on, you can build up **a long list of branches that are no
longer needed**. They've been merged into ``master``, what do we do with them
now?

The answer
----------

Using ``git-sweep-merged-and-stale`` you can **safely remove remote branches that have been
merged into master**.

To install it run:

::

    pip install git-sweep-merged-and-stale || easy_install git-sweep-merged-and-stale

Try it for yourself (safely)
----------------------------

To see a list of branches that git-sweep-merged-and-stale detects are merged into your master branch:

You need to have your Git repository as your current working directory.

::

    $ cd myrepo

The ``preview`` command doesn't make any changes to your repo.

::

    $ git-sweep-merged-and-stale preview
    Fetching from the remote
    These branches have been merged into master:

      branch1
      branch2
      branch3
      branch4
      branch5

    To delete them, run again with `git-sweep-merged-and-stale cleanup`

If you are happy with the list, you can run the command that deletes these
branches from the remote, ``cleanup``:

::

    $ git-sweep-merged-and-stale cleanup
    Fetching from the remote
    These branches have been merged into master:

      branch1
      branch2
      branch3
      branch4
      branch5

    Delete these branches? (y/n) y
      deleting branch1 (done)
      deleting branch2 (done)
      deleting branch3 (done)
      deleting branch4 (done)
      deleting branch5 (done)

    All done!

    Tell everyone to run `git fetch --prune` to sync with this remote.
    (you don't have to, yours is synced)

*Note: this can take a little time, it's talking over the tubes to the remote.*

You can also give it a different name for your remote and master branches.

::

    $ git-sweep-merged-and-stale preview --master=develop --origin=github
    ...

Tell it to skip the ``git fetch`` that it does by default.

::

    $ git-sweep-merged-and-stale preview --nofetch
    These branches have been merged into master:

      branch1

    To delete them, run again with `git-sweep-merged-and-stale cleanup --nofetch`

Make it skip certain branches.

::

    $ git-sweep-merged-and-stale preview --skip=develop
    Fetching from the remote
    These branches have been merged into master:

      important-upgrade
      upgrade-libs
      derp-removal

    To delete them, run again with `git-sweep-merged-and-stale cleanup --skip=develop`

Once git-sweep-merged-and-stale finds the branches, you'll be asked to confirm that you wish to
delete them.

::

    Delete these branches? (y/n)

You can use the ``--force`` option to bypass this and start deleting
immediately.

::

    $ git-sweep-merged-and-stale cleanup --skip=develop --force
    Fetching from the remote
    These branches have been merged into master:

      important-upgrade
      upgrade-libs
      derp-removal

      deleting important-upgrade (done)
      deleting upgrade-libs (done)
      deleting derp-removal (done)

    All done!

    Tell everyone to run `git fetch --prune` to sync with this remote.
    (you don't have to, yours is synced)
    
    
Deleting local branches
-----------------------

You can also clean up local branches by using simple hack:

:: 

    $ cd myrepo
    $ git remote add local $(pwd)
    $ git-sweep-merged-and-stale cleanup --origin=local
    

Development
-----------

I just use ``pytest`` to test this.

Requirements
------------

* Git
* Python >= 3.6

License
-------

Friendly neighborhood MIT license.

.. _GitHub Flow: http://scottchacon.com/2011/08/31/github-flow.html
.. _git-flow: http://nvie.com/posts/a-successful-git-branching-model/
.. _git-sweep: https://github.com/arc90/git-sweep