Skip to content

Commit

Permalink
Add scriv to simplify creating the changelog
Browse files Browse the repository at this point in the history
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
Nicoretti authored Aug 5, 2022
1 parent cc49684 commit 6409293
Show file tree
Hide file tree
Showing 11 changed files with 911 additions and 231 deletions.
617 changes: 617 additions & 0 deletions CHANGELOG.rst

Large diffs are not rendered by default.

227 changes: 0 additions & 227 deletions CHANGES.md

This file was deleted.

Empty file added changelog.d/.keep
Empty file.
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

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.
..
34 changes: 34 additions & 0 deletions changelog.d/templates/fragment-template.rst
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.
..
37 changes: 37 additions & 0 deletions doc/developer_guide/developer_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,44 @@ Tests

If something still is not working or unclear, you may want to look into the CI/CD action_ files.

Changelog (scriv)
-----------------
What, why and from whom to write a changelog you can read up on keepachangelog_, in
this section we just want give the information on how to keep track of fragments
which later will be used to create the changelog on the next published release.

For the bookkeeping and generation of the changelog we use scriv_, so if you
find the information in this section not sufficient we recommend to consult the
scriv_ documentation.

.. note::

keep in mind that all our docs, including the changelog are in the
restructuredText format when you format your entries.


Run the following command to create a new changelog fragment.

.. code-block:: shell
scriv create --edit
An editor will open and you get prompted with a template, uncomment
sections headings you need and add your entries below.
Also make sure you commit the created fragment once you're done.

.. note::

To make sure you won't forgetting to commit the fragment, you can use
the `--add` flag to automatically add it to the git index.

.. code-block:: shell
scriv create --edit --add
.. _scriv: https://scriv.readthedocs.io/en/latest/index.html
.. _keepachangelog: https://keepachangelog.com/en/1.1.0/
.. _action: https://github.com/exasol/sqlalchemy_exasol/actions
.. _python: https://www.python.org/
.. _poetry: https://python-poetry.org/
Expand Down
Loading

0 comments on commit 6409293

Please sign in to comment.