Maintainer is a CLI app which helps you to generate AUTHORS, CHANGELOG.md, CONTRIBUTING.md and so on based on the repository in GitHub. It makes your repository more contributor-friendly.
$ go get github.com/maintainer-org/maintainer $ maintainer --help maintainer is a CLI app to help you to generate AUTHORS, CONTRIBUTING.md, CHANGELOG.md and so on. Usage: maintainer [command] Available Commands: changelog Generate CHANGELOG.md for your repository. contributing Generate CONTRIBUTING.md for your repository. contributor Generate AUTHORS.md for your repository. readme Generate README.md related text in your repository. Flags: --config string config file (default is $HOME/.maintainer.yaml) -h, --help help for maintainer Use "maintainer [command] --help" for more information about a command.
$ docker pull gaocegege/maintainer $ docker run --rm -v $(pwd):/workdir gaocegege/maintainer:latest --help
There is only one configuration now: the token in GitHub. The token can be created from https://github.com/settings/tokens/new?description=Maintainer%20CLI%20token, you only need "repo" scope for private repositories.
It is used in changelog subcommand, so there are three ways to config the token:
$HOME/.maintainer.yml. ./.maintainer.yml.template is a template.
maintainer changelog --token <token>. If you set it in command, it will override the configuration in config file and the environment variable.
changelog subcommand will generate CHANGELOG.md for your repository, it is supported via github_changelog_generator, so you need to install it before the subcommand is called.
See here about how to install github_changelog_generator. In the future, maintainer will support install this dependency automatically.
See CHANGELOG.md as an example.
contributing subcommand will generate CONTRIBUTING.md for your repository, now this file is a general version.
In the future, maintainer will detect languages and generate corresponding documentation about programming language specific flow for contribution.
See CONTRIBUTING.md as an example.
contributor subcommand will generate AUTHORS just like moby/moby does. It gives the contributors more passion to contribute.
See AUTHORS.md as an example.
user daily and user summary subcommands will generate daily report or summary for the given user.
maintainer user --username gaocegege daily maintainer user --username gaocegege summary --begin 2019-05-20 --end 2019-05-22
Please notice that GitHub only shows the first 300 events for one user which is a core limitation for this feature.
readme subcommand contains some subcommands:
tocsubcommand, which could generate table of contents(TOC) for README.md. It is supported with gh-md-toc, so you need to install it before the subcommand is called.
People ❤️ badges. badge subcommand will recommend badges for you based on which languages the repository is written in.
go run main.go <subcommand>
Maintainer requires two steps to build a Docker image.
maintainerin a Docker container which from
golang:1.8-alpine. It mounts maintainer directory into the container so the
maintainerbuilt from code will visiable in host.
docker build -t maintainer .builds real image from
Dockerfile. It simply copys binary
maintainerinto the image and install some dependencies such as git and github_changelog_generator.
This way is inspired by caicloud/cyclone. It could reduce the size of image significantly.