Giter VIP home page Giter VIP logo

four-key's Introduction

4-key-metrics

four-key Metrics

four-key is a measure tool written with golang for your repositories. This project inspired from Accelerate book.

Thoughtworks Technology Radar

Documentation on Gitbook ๐Ÿ”—

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 a pull request.

Dependencies

  • git

Prerequisites


  • All releases must be tagged with a specific prefix and version number [prefix][versionNumber] like release-v15 or v-[commitSha] or rel12
  • Must be provided with -p yourTagPattern while adding repository OR add to config.json
  • All fixes must be specific like fix - hotfix - hot-fix
  • Must be provided with -c yourFixCommitPattern -c yourOtherCommitFixPattern -c yourOtherCommitFixPattern while adding repository OR add to config.json

Installation

Executables

Source Code Build
$ git clone https://github.com/Trendyol/four-key.git && cd four-key
$ go build

Preparation

// 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

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

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

TODO

  • Add brew & scoop as installation options (TODO)
  • Complete tests (In Progress)
  • Add CI
  • Add calculation descriptions to wiki (In Progress)
  • Add suggestions for metrics results

License

The MIT License (MIT) - see LICENSE.md for more details

four-key's People

Contributors

aslihanozfidan avatar burakolgun avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

four-key's Issues

Ui bugs

Hello @aslihanozfidan ,

I see a few bugs occurring during your development. Can u fix these?

These bugs are as follows;

image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.