Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dlanileonardo/step-changelog-generator

Changelog Generator Step for Wercker
https://github.com/dlanileonardo/step-changelog-generator

Last synced: 4 days ago
JSON representation

Changelog Generator Step for Wercker

Awesome Lists containing this project

README

        

Changelog Generator Step
-------------------------

[![wercker status](https://app.wercker.com/status/e1ec7279f3af5a298140c2da6eb60f11/s "wercker status")](https://app.wercker.com/project/bykey/e1ec7279f3af5a298140c2da6eb60f11)

## REQUIREMENTS

* `github_token` - Your Github API Token
* `github_user` - Your personal github user
* `github_repo` - Name of repository on github

Options

* `github_name` - Name user will be appear in commits
* `github_email` - Email from user will be appear in commits

## Example Usage

```yml
build:
steps:
- dlanileonardo/generate-changelog:
github_token: $CHANGELOG_GITHUB_TOKEN
github_user: $CHANGELOG_GITHUB_USER
github_repo: $CHANGELOG_GITHUB_REPO
github_name: $CHANGELOG_GITHUB_NAME
github_email: $CHANGELOG_GITHUB_EMAIL
github_branch: $CHANGELOG_GITHUB_BRANCH
```

## CHANGELOG
See [CHANGELOG](CHANGELOG.md)

## WARNING

This step will commit a CHANGELOG.md in specified repository.

* This step use gem github-changelog-generator (https://github.com/skywinder/github-changelog-generator)