-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add scriv to simplify creating the changelog
fixes #166 * Add scriv as dev dependency * Add scriv fragment template * Add scriv configuration * Migrate the changelog to scriv based .rst format * Delete old changelog file * Add changelog fragment reflecting the latest changes * Add information about changelog management to dev docs * Bump version to 3.1.9
- Loading branch information
Showing
11 changed files
with
911 additions
and
231 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Empty file.
15 changes: 15 additions & 0 deletions
15
...805_071536_nicola.coretti__166_add_scriv_to_simplify_creating_the_changelog.rst
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,15 @@ | ||
🗑️ Removed | ||
---------- | ||
- Removed markdown based changelog | ||
|
||
✨ Added | ||
-------- | ||
- Added additional information to README | ||
* License information (badge) | ||
* Code formatter(s) in use (black, isort) | ||
* Linting score of the project | ||
|
||
🔧 Changed | ||
---------- | ||
- Changed changelog format and file, the changelog now can be found in the file CHANGELOG.rst | ||
|
33 changes: 33 additions & 0 deletions
33
...805_073754_nicola.coretti__166_add_scriv_to_simplify_creating_the_changelog.rst
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,33 @@ | ||
.. A new scriv changelog fragment. | ||
.. | ||
.. Uncomment the header that is right (remove the leading dots). | ||
.. | ||
.. 🗑️ Removed | ||
.. ---------- | ||
.. | ||
.. - A bullet item for the Removed category. | ||
.. | ||
.. ✨ Added | ||
.. -------- | ||
.. | ||
.. - A bullet item for the Added category. | ||
.. | ||
🔧 Changed | ||
---------- | ||
- Updated the developer documents to reflect the latest changelog management | ||
.. | ||
.. 🚧 Deprecated | ||
.. ------------- | ||
.. | ||
.. - A bullet item for the Deprecated category. | ||
.. | ||
.. 🐞 Fixed | ||
.. -------- | ||
.. | ||
.. - A bullet item for the Fixed category. | ||
.. | ||
.. 🔐 Security | ||
.. ----------- | ||
.. | ||
.. - A bullet item for the Security category. | ||
.. |
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,34 @@ | ||
.. A new scriv changelog fragment. | ||
.. | ||
.. Uncomment the header that is right (remove the leading dots). | ||
.. | ||
.. 🗑️ Removed | ||
.. ---------- | ||
.. | ||
.. - A bullet item for the Removed category. | ||
.. | ||
.. ✨ Added | ||
.. -------- | ||
.. | ||
.. - A bullet item for the Added category. | ||
.. | ||
.. 🔧 Changed | ||
.. ---------- | ||
.. | ||
.. - A bullet item for the Changed category. | ||
.. | ||
.. 🚧 Deprecated | ||
.. ------------- | ||
.. | ||
.. - A bullet item for the Deprecated category. | ||
.. | ||
.. 🐞 Fixed | ||
.. -------- | ||
.. | ||
.. - A bullet item for the Fixed category. | ||
.. | ||
.. 🔐 Security | ||
.. ----------- | ||
.. | ||
.. - A bullet item for the Security category. | ||
.. |
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
Oops, something went wrong.