Skip to content

Commit

Permalink
docs: update changelog sample
Browse files Browse the repository at this point in the history
  • Loading branch information
adhocore committed Aug 3, 2019
1 parent 07ec9b9 commit 22e918d
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,21 +134,23 @@ And here is a preview of all [features](https://www.npmjs.com/package/@adhocore/

[CHANGELOG.md](./CHANGELOG.md) generated by `please` looks like:

```
## [0.0.1] 2018-01-01 00:00:00 UTC
```md
## [0.0.1](https://github.com/<repo>/releases/tag/<0.0.1>) (2018-01-01)

- commit 1 (Author Name)
- commit 2 (Author Name)
### Features
- **scope**: commit 1 (Author Name)
- **scope**: commit 2 (Author Name)
...
```

If you passed in `--chash` flag then:

```
## [0.0.1] 2018-01-01 00:00:00 UTC
```md
## [0.0.1](https://github.com/<repo>/releases/tag/<0.0.1>) (2018-01-01)

- [<commit1hash>](https://github.com/<repo>/commit/<commit1hash>) commit 1 (Author Name)
- [<commit2hash>](https://github.com/<repo>/commit/<commit2hash>) commit 2 (Author Name)
### Features
- **scope**: commit 1 (Author Name) [_hash1_](https://github.com/<repo>/commit/<hash1>)
- **scope**: commit 2 (Author Name) [_hash2_](https://github.com/<repo>/commit/<hash2>)
...
```

Expand Down

0 comments on commit 22e918d

Please sign in to comment.