Skip to content

Commit

Permalink
Cleanup readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jimschubert committed Mar 14, 2020
1 parent 9cc61f7 commit e08ff42
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,8 @@ More advanced scenarios require an external JSON configuration object which can

```json5
{
// "commits" or "prs", defaults to commits. "prs" will soon allow for resolving labels from pull requests
// "commits" or "prs", defaults to commits. "prs" will soon allow for resolving labels
// from pull requests
"resolve": "commits",

// "asc" or "desc", determines the order of commits in the output
Expand All @@ -127,7 +128,8 @@ More advanced scenarios require an external JSON configuration object which can
{ "name": "Contributions", "patterns": [ "(?i)\\bfeat\\b" ] }
],

// Exclude commits based on this set of patterns or texts (useful for common maintenance commit messages)
// Exclude commits based on this set of patterns or texts
// (useful for common maintenance commit messages)
"exclude": [
"^(?i)release\\s+\\d+\\.\\d+\\.\\d+",
"^(?i)minor fix\\b",
Expand Down Expand Up @@ -208,21 +210,22 @@ Now, run this against [cli/cli](https://github.com/cli/cli) v0.5.6 and v0.5.7. V

```bash
docker run -e GITHUB_TOKEN=yourtoken \
-e GITHUB_OWNER=cli \
-e GITHUB_REPO=cli \
docker.pkg.github.com/jimschubert/changelog/changelog:latest -f v0.5.6 -t v0.5.7 >> /tmp/changelog/CHANGELOG.md
-e GITHUB_OWNER=cli \
-e GITHUB_REPO=cli \
jimschubert/changelog:latest -f v0.5.6 -t v0.5.7 >> /tmp/changelog/CHANGELOG.md
```

And via cli:

```bash
export GITHUB_TOKEN=your-token
./changelog -o cli -r cli -f v0.5.6 -t v0.5.7 -c /tmp/changelog/config.json >> /tmp/changelog/CHANGELOG.md
./changelog -o cli -r cli -f v0.5.6 -t v0.5.7 \
-c /tmp/changelog/config.json >> /tmp/changelog/CHANGELOG.md
```

This changelog output in `/tmp/changelog/CHANGELOG.md` should look like this:

```json
```text
## v0.5.7
### Fixes
Expand Down

0 comments on commit e08ff42

Please sign in to comment.