Skip to content

Commit

Permalink
Added note about Keep a Changelog format
Browse files Browse the repository at this point in the history
  • Loading branch information
NicoHood committed Jan 29, 2021
1 parent bf7cafd commit 345fb38
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ gpgit --help
## Script Usage
The script guides you through all 5 steps of the [GPG quick start guide](#gpg-quick-start-guide). Run GPGit with the tag name as parameter. All other options will get auto detected. When running the script for the first time GPGit runs in interactive (`-i`) mode and guide you through all steps of secure source code signing.

If you add and commit a `CHANGELOG.md` file to your Git with the [Keep a Changelog](https://keepachangelog.com/) format, GPGit will autodetect that file and add the corresponding changelog section to the tag message and Github release notes.

### Sample Usage
![screenshot](img/screenshot.png)

Expand Down

0 comments on commit 345fb38

Please sign in to comment.