https://github.com/stefanwalther/docker-github-changelog-generator
Docker image to use the GitHub Changelog Generator.
https://github.com/stefanwalther/docker-github-changelog-generator
changelog commits documentation documentation-generator generator git github readme
Last synced: about 2 months ago
JSON representation
Docker image to use the GitHub Changelog Generator.
- Host: GitHub
- URL: https://github.com/stefanwalther/docker-github-changelog-generator
- Owner: stefanwalther
- Created: 2017-09-24T11:17:58.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T05:38:55.000Z (over 2 years ago)
- Last Synced: 2026-02-10T02:41:40.703Z (5 months ago)
- Topics: changelog, commits, documentation, documentation-generator, generator, git, github, readme
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
Awesome Lists containing this project
README
# docker-github-changelog-generator
> Docker image to use the GitHub Changelog Generator.
---
## Installation
```sh
$ docker pull stefanwalther/github-changelog-generator
```
The Docker image is stored on Docker Hub.
## Usage
```sh
$ docker run --rm -v ${PWD}:/app stefanwalther/github-changelog-generator [ARGS]
```
### Using npm script
A convenient method to use this Docker image is to set up a script within your `package.json` file, e.g.:
```json
"scripts": {
"changelog": "docker run --rm -v ${PWD}:/app stefanwalther/github-changelog-generator -t ${GITHUB_CHANGELOG_GENERATOR_TOKEN} -u -p "
}
```
This requires that you have set up the following environment variable on your machine:
```sh
$ export GITHUB_CHANGELOG_GENERATOR_TOKEN="YOUR_GITHUB_TOKEN_HERE"
```
## Configuration
See [github-changelog-generator](https://github.com/skywinder/github-changelog-generator) and [Advanced change log generation examples](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples) for more details.
## About
### Author
**Stefan Walther**
* [twitter](http://twitter.com/waltherstefan)
* [github.com/stefanwalther](http://github.com/stefanwalther)
* [LinkedIn](https://www.linkedin.com/in/stefanwalther/)
* [qliksite.io](http://qliksite.io)
### License
MIT
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on February 28, 2018._