Skip to content
Changelog generator : use a git repository and various data sources and publish the result on external services
Go Other
  1. Go 98.8%
  2. Other 1.2%
Branch: master
Clone or download
antham Merge pull request #50 from antham/dependabot/go_modules/github.com/s…
…tretchr/testify-1.4.0

Bump github.com/stretchr/testify from 1.3.0 to 1.4.0
Latest commit c7633a8 Aug 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci root : add missing golang-ci step Jul 10, 2019
chyle root : update logrus Dec 1, 2018
cmd
docs
features
logo Add files via upload Jun 2, 2018
prompt
.doc-hunt test(.doc-hunt) : update Dec 15, 2017
.gitignore root : upgraded to 4.1.1 of go-git Feb 26, 2018
.gommit.toml root : update gommit Mar 1, 2019
LICENSE.txt feat(init) : first commit Nov 17, 2016
Makefile root : add missing golang-ci step Jul 10, 2019
README.md
go.mod Bump github.com/stretchr/testify from 1.3.0 to 1.4.0 Aug 16, 2019
go.sum Bump github.com/stretchr/testify from 1.3.0 to 1.4.0 Aug 16, 2019
main.go feat(all) : add cobra Nov 17, 2016
test.sh feat(Makefile) : add Nov 21, 2016

README.md

chyle

CircleCI codecov codebeat badge Go Report Card GolangCI GoDoc GitHub tag

Chyle produces a changelog from a git repository.

asciicast



Usage

Create a changelog from your commit history

Usage:
  chyle [command]

Available Commands:
  config      Configuration prompt
  create      Create a new changelog
  help        Help about any command

Flags:
      --debug   enable debugging
  -h, --help    help for chyle

Use "chyle [command] --help" for more information about a command.

config

Run a serie of prompt to help generate quickly and easily a configuration.

create

Generate changelog.

How it works ?

Chyle fetch a range of commits using given criterias from a git repository. From those commits you can extract relevant datas from commit message, author, and so on, and add it to original payload. You can afterwards if needed, enrich your payload with various useful datas contacting external apps (shell command, apis, ....) and finally, you can publish what you harvested (to an external api, stdout, ....). You can mix all steps together, avoid some, combine some, it's up to you.

Setup

Download from release page according to your architecture chyle binary : https://github.com/antham/chyle/releases

Look at the documentation and examples, run chyle config to launch the configuration prompt.

Documentation and examples

Have a look to the wiki of this project.

Contribute

If you want to add a new feature to chyle project, the best way is to open a ticket first to know exactly how to implement your changes in code.

Setup

After cloning the repository you need to install vendors with go mod vendor To test your changes locally you can run go tests with : make test-all

You can’t perform that action at this time.