forke v1.1.4

Forke

Forke is a simple CLI tool designed to measure development productivity from GitHub info.

Install

# Install
npm install -g forke

# This npm requires GITHUB_TOKEN, so please set it in the environment variable in any way.
export GITHUB_TOKEN='...'

Concepts

This tool is designed to measure Four Keys, a development productivity indicator.

Measuring the Four Keys is not enough; it is important to link the results of the measurement to improvements. For this reason, a stat command is provided to retrieve the indicators and a list command to output the original data of the indicators. The user of the tool is expected to see from the results of the list command which work of the development team is the bottleneck when each indicator is bad.

Lead time for changes & Deployment frequency

[BaseBranch]                                                    to LeadTimeBranch |  to DeployBranch |
|---------------------------------- lead time ------------------------------------|--   No Stat    --|
|-- timeFromCommitToOpen --|-- timeFromOpenToReview --|-- timeFromReviewToMerge --|------------------|
------------------------------------------------------------------------------------------------------
^                          ^                          ^                           ^                  ^
first commit        create PullRequest            first review              merge PullRequest       release

• Deployment frequency = Number of PullRequests targeting DeployBranch
• Lead time for changes = timeFromCommitToOpen + timeFromOpenToReview + timeFromReviewToMerge.
  • As shown in the figure, the time between the merge and the deployment is not captured by Forke.
  • As the deployment process is heavily influenced by the business side, I have decided that it is not possible to drill down from the GitHub data and have used this specification, but I may make it possible to obtain this information in the future.

Change failure rate & Time to restore service

• Change failure rate = (Number of PullRequests targeting LeadTimeBranch and head is hotfixBranch) / (Number of PullRequests targeting LeadTimeBranch)
• Time to restore service = Average(Lead time of PullRequests targeting LeadTimeBranch and head is hotfixBranch)
  • The Lead 　 time calculation method is the same as for calculating lead time for changes.

Usage

List PullRequests

List merged pull requests that match the search conditions are output to standard output.

npx forke list --query ...

Result

Options

The following options can be specified.

# ex)
npx forke list -f 2023-04-01T00:00:00+09:00 -q 'base:main base:release' --format json --timeunit hour

Create Stats

Output statistics from pull requests that match the specified conditions.

npx forke stat --query ...

Result

Options

The following options can be specified.

# ex)
npx forke stat -f 2023-04-01T00:00:00+09:00 -q 'base:main base:release' --format json --timeunit hour --deployBranch release

Contribution

Issues

The following Issue is accepted (English or Japanese).

• Questions about features
• Report errors or problems
• Propose additions or improvements to feature

Please click here to issue.

How to send Pull Request

1. Fork the repository
2. Create a branch
3. Add or modify feature
4. Run unit test
5. Check the feature in your terminal
6. Commit Changes
7. Push branch
8. Create Pull Request

How to set up a Local Development Environment

First, clone the forked repository locally.

git clone git@github.com:IkumaTadokoro/forke.git

Install dependencies.

npm i

(Option) Setup envfile for debug. When the configuration is complete, the script can be executed in npm run dev -- <command> <options>.

cp .env.sample .env
# Set your secrets in .env.

That's it. Happy coding :+1:

License

Forke is available under the MIT License.