Skip to content
This repository was archived by the owner on Aug 17, 2022. It is now read-only.

loveOSS/kimeo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kimeo: the missing contributions reporter for GitHub

Kimeo is a micro CLI application (and a minimalist web client) that is able to generate a list of merged PR for a selected list of branches for an interval of dates.

kimeo_cli

Installation

The login/password credentials are your GitHub's ones.

 dev@dev:~$ composer global require loveOSS/kimeo
 dev@dev:~$ export PATH="$PATH:$HOME/.composer/vendor/bin"

Then configure the application, you need to create and complete a .env file. Use the .env.dist file provided:

GITHUB_OWNER=mickaelandrieu # the owner of GitHub project
GITHUB_REPOSITORY=kimeo # the name of GitHub project

GITHUB_LOGIN=mickaelandrieu # the name of GitHub account (for authentication)
GITHUB_PASSWORD=XXXXXXXXX # the password of GitHub account

CORE_MEMBERS=mickaelandrieu

What are Core members?

For theses members, the line generated for each contributed will be different.

For Core members (ex):

  • #7839: Add sprintf check constraint on translations, by @Quetzacoalt91.

For beloved contributors (ex):

  • #7838: Return empty array instead of false.. Thank you @neoteknic!

How to use the CLI application?

 dev@dev:~$ kimeo <from> <to> <list> <of> <branches> <...>

For instance:

 dev@dev:~$ kimeo 31-10-2016 9-12-2016 main feat-1

How to use the Web client?

dev@dev:~$ cd /path/to/kimeo && php -S localhost:1234 # Then access http://localhost:1234

kimeo_web

A file named report.md will be generated, you can manipulate it using any programming language.

This is so great, I want to contribute! Where are the tests?

Ahaha, well tried ;) I don't want any contributions. If you like it, star it and use it. If you want to improve it, fork it and create the tool that fits your specific needs.

About

The missing contributions reporter for GitHub 📝

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published