-
Notifications
You must be signed in to change notification settings - Fork 849
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[apps] List contributors using the changelog generation script (#2456)
- Loading branch information
1 parent
90d2f07
commit 0bc3b03
Showing
4 changed files
with
46 additions
and
26 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Script Description | ||
|
||
Script designed to generate release notes template with main sections, contributors list, and detailed changelog out of `.csv` SRT git log file. The output `release-notes.md` file is generated in the root folder. | ||
|
||
In order to obtain the git log file since the previous release (e.g., v1.4.0), use the following command: | ||
|
||
``` | ||
git log --pretty=format:"%h|%s|%an|%ae" v1.4.0...HEAD^ > commits.csv | ||
``` | ||
|
||
## Requirements | ||
|
||
* Python 3.6+ | ||
|
||
To install Python libraries use: | ||
``` | ||
pip install -r requirements.txt | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.