2024-10-03 09:03:28 +02:00
|
|
|
Release
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
What qualifies as release?
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
A new release should be announced when a significant number functions, bugfixes or other improvements to the software
|
2025-01-18 09:07:33 +01:00
|
|
|
is made. Notfellchen follows `Semantic Versioning <https://semver.org/>`_.
|
2024-10-03 09:03:28 +02:00
|
|
|
|
|
|
|
|
What should be done before a release?
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
Tested basic functions
|
|
|
|
|
######################
|
|
|
|
|
|
2025-01-18 09:07:33 +01:00
|
|
|
Run :command:`nf test src`
|
2024-10-03 09:03:28 +02:00
|
|
|
|
|
|
|
|
Test upgrade on a copy of a production database
|
|
|
|
|
###############################################
|
|
|
|
|
|
|
|
|
|
.. WARNING::
|
|
|
|
|
You have to prevent e-mails from being sent, otherwise users could receive duplicate e-mails!
|
|
|
|
|
|
|
|
|
|
* Ensure correct migration if necessary
|
|
|
|
|
* Views correct?
|
|
|
|
|
|
|
|
|
|
Release
|
|
|
|
|
^^^^^^^
|
|
|
|
|
|
|
|
|
|
After testing everything you are good to go. Open the file :file:`src/setup.py` with a text editor
|
|
|
|
|
you can adjust the version number:
|
|
|
|
|
|
|
|
|
|
Do a final commit on this change, and tag the commit as release with appropriate version number.
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
git tag -a v1.0.0 -m "Releasing version v1.0.0"
|
|
|
|
|
git push origin v1.0.0
|
|
|
|
|
|
2025-01-18 09:07:33 +01:00
|
|
|
Make sure the tag is visible on GitHub/Codeberg and celebrate 🥳
|
