Skip to content

Commit

Permalink
🔖 prepared release 0.1.5
Browse files Browse the repository at this point in the history
  • Loading branch information
dominikbraun committed Jan 23, 2020
1 parent c5edde4 commit 74f153a
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 13 deletions.
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
<h3 align="center">cleanup &ndash; Remove gone Git branches with ease.</h3>

<p align="center">
<img src="https://circleci.com/gh/dominikbraun/foodunit.svg?style=shield">
<img src="https://goreportcard.com/badge/github.com/dominikbraun/foodunit">
<img src="https://www.codefactor.io/repository/github/dominikbraun/dice/badge?s=0f13518b90c29be6bc3ec4ff537581a2e5c51c6a" />
<img src="https://img.shields.io/github/v/release/dominikbraun/foodunit?sort=semver">
<img src="https://img.shields.io/badge/license-Apache--2.0-brightgreen">
<a href="https://circleci.com/gh/dominikbraun/cleanup"><img src="https://circleci.com/gh/dominikbraun/cleanup.svg?style=shield"></a>
<a href="https://goreportcard.com/report/github.com/dominikbraun/cleanup"><img src="https://goreportcard.com/badge/github.com/dominikbraun/cleanup"></a>
<a href="https://www.codefactor.io/repository/github/dominikbraun/cleanup"><img src="https://www.codefactor.io/repository/github/dominikbraun/cleanup/badge" /></a>
<a href="https://github.com/dominikbraun/cleanup/releases"><img src="https://img.shields.io/github/v/release/dominikbraun/cleanup?sort=semver"></a>
<a href="https://github.com/dominikbraun/cleanup/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-brightgreen"></a>
<br>
<br>
<br>
Expand All @@ -23,11 +23,11 @@

:dizzy: cleanup is a CLI tool for keeping your Git repositories clean. It removes old branches in one or more repositories with a single command.

**Project status:** In active development and stable to use.
**Project status:** In active development. Can be used already, but without warranty.

## <img src="https://sternentstehung.de/cleanup-dot.png"> Usage

You merely need to provide the path to your repository. For example, change into your project directory and remove all gone branches:
You merely need to provide the path to your repository. For example, change into your project directory and remove all gone branches like this:

````shell script
$ cleanup branches .
Expand Down Expand Up @@ -67,31 +67,37 @@ Copy the downloaded binary into a directory like `/usr/local/bin`. Make sure the

**Windows**

Create a directory like `C:\Program Files\cleanup` and copy downloaded executable into it. [Add the direcotry](https://www.computerhope.com/issues/ch000549.htm) to `Path`.
Create a directory like `C:\Program Files\cleanup` and copy the executable into it. [Add the directory](https://www.computerhope.com/issues/ch000549.htm) to `Path`.

## <img src="https://sternentstehung.de/cleanup-dot.png"> Remove branches periodically

Especially developers working in larger teams may want to clean up their repositories periodically.

**Linux/macOS**

Edit the cronjob table.
Edit cron's job table.

````shell script
$ crontab -e
````

Adding a line like this will run cleanup every day at 11 PM for _all_ repositories. Make sure you provide a correct paths to the cleanup binary and project directory.
Adding a line like this will run cleanup every day at 11 PM for _all_ repositories. Make sure you provide correct paths to the cleanup binary and project directory.

````shell script
0 23 * * * /usr/local/bin/cleanup branches --has-multiple-repos /home/user/projects
````

**Windows**

You can created a scheduled task via GUI or command prompt. Again, make sure to provide correct paths for the cleanup executable and project directory.
Just create a scheduled task like this &ndash; and make sure to provide correct paths for the cleanup executable and project directory.

````shell script
> SCHTASKS /CREATE /SC DAILY /ST 23:00 /TN "Clean up repositories" ^
/TR "C:\Path\To\cleanup.exe branches --has-multiple-repos C:\Path\To\Projects"
````
````

<p align="center">
<br>
<strong>クリーン</strong>
<br>
</p>
1 change: 1 addition & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljT
github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q=
golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ func main() {
cleanup := &cobra.Command{
Use: "cleanup",
Short: `💫 Remove gone Git branches with ease.`,
Version: "0.1.0",
Version: "0.1.5",
RunE: func(cmd *cobra.Command, args []string) error {
return nil
},
Expand Down

0 comments on commit 74f153a

Please sign in to comment.