initial commit

.gitignore

@@ -0,0 +1,56 @@
+_Store
+*.[56789ao]
+*.a[56789o]
+*.so
+*.pyc
+._*
+.nfs.*
+[56789a].out
+*~
+*.orig
+*.rej
+.*.swp
+core
+*.cgo*.go
+*.cgo*.c
+_cgo_*
+_obj
+_test
+_testmain.go
+
+/VERSION.cache
+/bin/
+/build.out
+/doc/articles/wiki/*.bin
+/goinstall.log
+/last-change
+/misc/cgo/life/run.out
+/misc/cgo/stdio/run.out
+/misc/cgo/testso/main
+/pkg/
+/src/*.*/
+/src/cmd/cgo/zdefaultcc.go
+/src/cmd/dist/dist
+/src/cmd/go/internal/cfg/zdefaultcc.go
+/src/cmd/go/internal/cfg/zosarch.go
+/src/cmd/internal/objabi/zbootstrap.go
+/src/go/build/zcgo.go
+/src/go/doc/headscan
+/src/runtime/internal/sys/zversion.go
+/src/unicode/maketables
+/test.out
+/test/garbage/*.out
+/test/pass.out
+/test/run.out
+/test/times.out
+/.idea/
+.idea
+/.idea
+
+# This file includes artifacts of Go build that should not be checked in.
+# For files created by specific development environment (e.g. editor),
+# use alternative ways to exclude files from git.
+# For example, set up .git/info/exclude or use a global .gitignore.
+
+/repos
+

.travis.yml

@@ -0,0 +1,18 @@
+language: go
+
+go:
+  - master
+
+install:
+  - go mod download
+
+notifications:
+  email: true
+
+os: osx
+
+script:
+  - go test -race -coverprofile=../coverage.txt -covermode=atomic
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2020
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,146 @@
+<p align="center">
+  <a href="#">
+    <img alt="4-key-metrics" src="./assets/logo.png" width="1180">
+  </a>
+</p>
+
+<h1 align="center">
+  four-key Metrics
+</h1>
+
+<p align="center">
+  four-key is a measure tool written with golang for your repositories. This project inspired from <a href="https://itrevolution.com/book/accelerate/">Accelerate</a> book.
+  <br></br>
+  <a href="https://www.thoughtworks.com/radar/techniques/four-key-metrics">Thoughtworks Technology Radar</a>
+</p>
+
+<p align="center">
+  <a href="#" target="_blank">Documentation on Gitbook 🔗</a>
+</p>
+
+<p align="center">
+  <a href="#"><img src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
+  <a href="https://travis-ci.org/{user}/{repository-name}"><img src="https://travis-ci.org/{user}/{repository-name}.svg?branch=master"></a>
+</p>
+
+This package provides cli-tool for your commits. You can measure lead time, deployment frequency, mean time to restore (MTTR) and change fail percentage of your repositories. If you want to contribute this package, please fork and [create](https://github.com/{user}/{repository-name}/pulls) a pull request.
+
+# Dependencies
+* git
+
+# Prerequisites
+<br>
+    <ul>
+    <li>All releases must be tagged with a specific prefix and version number  [prefix][versionNumber]  like release-v15 or v-[commitSha] or rel12</li>
+    <li>Must be provided with -p yourTagPattern while adding repository OR add to config.json </li>
+    <li>All fixes must be specific like fix - hotfix - hot-fix </li>
+    <li>Must be provided with -c yourFixCommitPattern -c yourOtherCommitFixPattern -c yourOtherCommitFixPattern while adding repository OR add to config.json </li>
+    </ul>
+
+
+# Installation
+
+Executables
+
+* Mac 64-bit: https://github.com/trendyol/
+* Linux 64-bit: https://github.com/trendyol/
+* Windows 64-bit: https://github.com/trendyol/
+
+```
+Source Code Build
+$ git clone https://github.com/Trendyol/four-key.git && cd four-key
+$ go build
+```
+
+# Preparation
+````cli
+// Add repository with CLI
+// OR Add repository with configuration file - Sample config.json
+{
+    "repositories":[
+        {
+            "teamName":"cs",
+            "cloneAddress": "https://github.com/Trendyol/reponame",
+            "releaseTagPattern": "v-",
+            "fixCommitPatterns": ["fix","hot-fix","hotfix"]
+        }
+    ]
+}
+
+````
+[![asciicast](https://asciinema.org/a/MHuwLNKOT9mifuCKPfy2QIUD9.svg)](https://asciinema.org/a/MHuwLNKOT9mifuCKPfy2QIUD9)
+````
+add command usage
+
+$ four-key add [flags]
+
+Flags:
+  -c, --cloneAddress string             Set your clone address
+  -f, --fixCommitPatterns stringArray   Set your fix commit patterns of repository
+  -h, --help                            help for add
+  -r, --releaseTagPattern string        Set your release tag pattern of repository
+  -t, --team string                     Set your team of repository
+
+````
+
+````
+list command usage
+
+$ four-key list [flags]
+
+Flags:
+  -h, --help                help for remove
+
+````
+
+````
+remove command usage
+
+$ four-key remove [flags]
+
+Flags:
+  -h, --help                help for remove
+  -r, --repository string   Set your repository name to remove from config
+
+````
+
+[![asciicast](https://asciinema.org/a/dqIcYF1HXSIscgRdy2zkPOaUq.svg)](https://asciinema.org/a/dqIcYF1HXSIscgRdy2zkPOaUq)
+
+````
+set command usage
+
+Usage:
+  four-key set [flags]
+
+Flags:
+  -h, --help            help for set
+  -o, --output string   Set output source of 4Key metric results
+````
+
+# Generate
+````
+$ four-key run --startDate 2018-01-13 --endDate 2020-01-30
+
+Usage:
+  four-key run [flags]
+
+Flags:
+  -e, --endDate string      Set a end date of range
+  -h, --help                help for run
+  -r, --repository string   Set a name of the specific repository
+  -s, --startDate string    Set a start date of range
+
+````
+
+[![asciicast](https://asciinema.org/a/XSWFQHdyz8rnaSG7VUqpoaa8F.svg)](https://asciinema.org/a/XSWFQHdyz8rnaSG7VUqpoaa8F)
+
+# TODO
+* Add calculation descriptions for all metrics (In Progress)
+* Add brew & scoop as installation options (In Progress)
+* Complete tests (In Progress)
+* Add CI
+* Complete Charts
+* Add suggestions for metrics results
+
+# License
+The MIT License (MIT) - see [`LICENSE.md`](https://github.com/Trendyol/four-key/LICENSE.md) for more details