captain-spike v1.1.0

Captain Spike: Spot the spiker

Idea

Imagine you are working on a team and you are practicing Xtreme Programming. Imagine you don't do code reviews because they are considered as harmful. And imagine that some of your colleagues love to commit without review or pair programming.

Time to stop this!

Usage

Installating from npm repository

# if you prefer npm
npm install -g captain-spike
# if you prefer yarn
yarn add --global captain-spike

Start Captain-Spike through local installation

captain-spike <target-git-repository>

Start Captain-Spike through docker

cd <your_repository>
docker container run --mount type=bind,source="$(pwd)",target=/repository,readonly --rm -i jaedle/captain-spike:latest

Output on single author commits

{
  "singleAuthorCommits": [
    "<commitId1>",
    "<commitId2>",
    "<commitId3>"
  ]
}

Outputs on no single author commits

{
  "singleAuthorCommits": []
}

Development

Prerequisites

• Have git installed: Version >= 2.14.0
• Have git-duet installed: Version >= 0.6.0

Building

To build Captain-Spike on your local machine you have to run the following commands:

Install dependencies

npm install

Run unit tests

npm run test

Run acceptance-tests

npm run acceptance-test

Please use eslint to force code style

npm run lint

running it locally

./bin/cli.js <options>

Docker build

You can even build captain spike within docker:

docker image build -t captain-spike:development .

Running it from docker:

docker container run --rm -i captain-spike:development <options>