diff --git a/source/releasing/fusiondirectory-integrator.rst b/source/releasing/fusiondirectory-integrator.rst new file mode 100644 index 0000000000000000000000000000000000000000..818e3d72063004dca6ee8607476e18e0ded5aef6 --- /dev/null +++ b/source/releasing/fusiondirectory-integrator.rst @@ -0,0 +1,83 @@ +How to release a FusionDirectory Integrator Version +=================================================== + +- Update the AUTHORS.md file +- Updates the Changelog.md file +- Write the upgrade documentation +- Update the UPGRADE.md +- Merge the fixes branch into master + +All those operations have to be made onto the 1.x-fixes branch each one +of them inside a ticket with the label ~release and with a **MR** + +Update the AUTHORS file +^^^^^^^^^^^^^^^^^^^^^^^ + +Add the authors of all the patchs we received to the AUTHORS file + +:: + + * Markus Amersdorfer <der.plusch@subnet.at> + Wiki setup, Testing, hints, proposals + +Updates the Changelog.md +^^^^^^^^^^^^^^^^^^^^^^^^ + +To update the Changelog.md you must first run the following command, at the end you have to put the milestone you want a changelog for + +.. code:: shell + + gitlab_changelog.py --config-file ~/.python-gitlab.cfg --gitlab fd --project "fusiondirectory/fusiondirectory-integrator" "FusionDirectory Integrator 1.1" + +Update the user documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +open an issue ins the `user manual issues`_ to update the release notes for +the supported version, label this issue ~release and with the correct +milestone + +The content should got into **source/fusiondirectory-integrator/supported** + +the file should be named like in this example current version to new version + +1.0-to-1.1.rst + +Update the UPGRADE documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Update UPGRADE.md with a new section for the new version corresponding +to what you have put into `user manual supported`_ after updating the documentation +for the release + +you can run for example + +.. code:: shell + + pandoc --from rst --to markdown -o 1.0-to-1.1.md 1.0-to-1.1.rst + +directly in the user-manual source to generate the content to copy/paste at the end of UPGRADE.MD + +Merge the fixes branch into master +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Only a gitlab master account user can do the merge on the master branch + +Tag the release +^^^^^^^^^^^^^^^ + +After merging the release we need to tag the release. go to `FusionDirectory Integrator tags`_ + +- Paste the Changelog.md corresponding to the release we just made + +Run the ci for the fusiondirectory-integrator website +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Once the tags for a release are created the CI of fusiondirectory-integrator needs to run +to update the fusiondirectory integrator website. + +The CI is at `FusionDirectory Integrator API`_ + +.. _user manual issues: https://gitlab.fusiondirectory.org/fusiondirectory/user-manual/-/issues +.. _user manual supported : https://fusiondirectory-user-manual.readthedocs.io/en/latest/fusiondirectory-integrator/update/supported/index.html +.. _FusionDirectory Integrator tags : https://gitlab.fusiondirectory.org/fusiondirectory/fusiondirectory-integrator/-/tags +.. _Fusiondirectory Integrator API : https://gitlab.fusiondirectory.org/applications/fusiondirectory-integrator/-/pipelines diff --git a/source/releasing/fusiondirectory-orchestrator.rst b/source/releasing/fusiondirectory-orchestrator.rst new file mode 100644 index 0000000000000000000000000000000000000000..99ccd9068703d73a7338fd69d8581c161563ce73 --- /dev/null +++ b/source/releasing/fusiondirectory-orchestrator.rst @@ -0,0 +1,83 @@ +How to release a FusionDirectory Version +======================================== + +- Update the AUTHORS.md file +- Updates the Changelog.md +- Write the upgrade documentation +- Update the UPGRADE.md +- Merge the fixes branch into master + +All those operations have to be made onto the 1.x-fixes branch each one +of them inside a ticket with the label ~release and with a **MR** + +Update the AUTHORS file +^^^^^^^^^^^^^^^^^^^^^^^ + +Add the authors of all the patchs we received to the AUTHORS file + +:: + + * Markus Amersdorfer <der.plusch@subnet.at> + Wiki setup, Testing, hints, proposals + +Updates the Changelog.md +^^^^^^^^^^^^^^^^^^^^^^^^ + +To update the Changelog.md you must first run the following command, at the end you have to put the milestone you want a changelog for + +.. code:: shell + + gitlab_changelog.py --config-file ~/.python-gitlab.cfg --gitlab fd --project "fusiondirectory/fusiondirectory-orchestrator "FusionDirectory Orchestrator 1.1" + +Update the user documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +open an issue ins the `user manual issues`_ to update the release notes for +the supported version, label this issue ~release and with the correct +milestone + +The content should got into **source/fusiondirectory-orchestrator/update/supported** + +the file should be named like in this example current version to new version + +1.0-to-1.1.rst + +Update the UPGRADE documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Update UPGRADE.md with a new section for the new version corresponding +to what you have put into `user manual supported`_ after updating the documentation +for the release + +you can run for example + +.. code:: shell + + pandoc --from rst --to markdown -o 1.0-to-1.1.md 1.0-to-1.1.rst + +directly in the user-manual source to generate the content to copy/paste at the end of UPGRADE.MD + +Merge the fixes branch into master +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Only a gitlab master account user can do the merge on the master branch + +Tag the release +^^^^^^^^^^^^^^^ + +After merging the release we need to tag the release. go to `FusionDirectory Orchestrator tags`_ + +- Paste the Changelog.md corresponding to the release we just made + +Run the ci for the FusionDirectory Orchestrator website +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Once the tag for a release are created the CI of FusionDirectory Orchestrator project needs to run +to update the FusionDirectory Orchestrator API website + +The CI is at `FusionDirectory Orchestrator API`_ + +.. _user manual issues: https://gitlab.fusiondirectory.org/fusiondirectory/user-manual/-/issues +.. _user manual supported : https://fusiondirectory-user-manual.readthedocs.io/en/latest/fusiondirectory-orchestrator/update/supported/index.html +.. _FusionDirectory Orchestrator tags : https://gitlab.fusiondirectory.org/fusiondirectory/fusiondirectory-orchestrator/-/tags +.. _FusionDirectory Orchestrator API : https://gitlab.fusiondirectory.org/applications/fusiondirectory-orchestrator/-/pipelines diff --git a/source/releasing/fusiondirectory-tools.rst b/source/releasing/fusiondirectory-tools.rst new file mode 100644 index 0000000000000000000000000000000000000000..971259aef531ea778f983ed69a25eaa7d69f0ccf --- /dev/null +++ b/source/releasing/fusiondirectory-tools.rst @@ -0,0 +1,74 @@ +How to release a FusionDirectory Tools Version +=============================================== + +- Update the AUTHORS.md file +- Updates the Changelog.md +- Write the upgrade documentation +- Update the UPGRADE.md +- Merge the fixes branch into master + +All those operations have to be made onto the 1.x-fixes branch each one +of them inside a ticket with the label ~release and with a **MR** + +Update the AUTHORS file +^^^^^^^^^^^^^^^^^^^^^^^ + +Add the authors of all the patchs we received to the AUTHORS file + +:: + + * Markus Amersdorfer <der.plusch@subnet.at> + Wiki setup, Testing, hints, proposals + +Updates the Changelog.md +^^^^^^^^^^^^^^^^^^^^^^^^ + +To update the Changelog.md you must first run the following command, at the end you have to put the milestone you want a changelog for + +.. code:: shell + + gitlab_changelog.py --config-file ~/.python-gitlab.cfg --gitlab fd --project "fusiondirectory/fusiondirectory-tools "FusionDirectory Tools 1.1" + +Update the user documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +open an issue ins the `user manual issues`_ to update the release notes for +the supported version, label this issue ~release and with the correct +milestone + +The content should got into **source/fusiondirectory-tools/update/supported** + +the file should be named like in this example current version to new version + +ex: 1.0-to-1.1.rst + +Update the UPGRADE documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Update UPGRADE.md with a new section for the new version corresponding +to what you have put into `user manual supported`_ after updating the documentation +for the release + +you can run for example + +.. code:: shell + + pandoc --from rst --to markdown -o 1.0-to-1.1.md 1.0-to-1.1.rst + +directly in the user-manual source to generate the content to copy/paste at the end of UPGRADE.MD + +Merge the fixes branch into master +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Only a gitlab master account user can do the merge on the master branch + +Tag the release +^^^^^^^^^^^^^^^ + +After merging the release we need to tag the release. go to `FusionDirectory Tools tags`_ + +- Paste the Changelog.md corresponding to the release we just made + +.. _user manual issues: https://gitlab.fusiondirectory.org/fusiondirectory/user-manual/-/issues +.. _user manual supported : https://fusiondirectory-user-manual.readthedocs.io/en/latest/fusiondirectory/update/supported/index.html +.. _FusionDirectory Tools tags : https://gitlab.fusiondirectory.org/fusiondirectory/fusiondirectory-tools/-/tags diff --git a/source/releasing/fusiondirectory-source.rst b/source/releasing/fusiondirectory.rst similarity index 100% rename from source/releasing/fusiondirectory-source.rst rename to source/releasing/fusiondirectory.rst diff --git a/source/releasing/index.rst b/source/releasing/index.rst index c2e5d9a0a36be8267624c55f1eaaa79db52f54c6..a3d04bbd6b62d38cd465c1bca3b7394d717ac2b0 100644 --- a/source/releasing/index.rst +++ b/source/releasing/index.rst @@ -6,6 +6,9 @@ How to create a release of our various softwares .. toctree:: :maxdepth: 2 - fusiondirectory-source.rst + fusiondirectory.rst + fusiondirectory-integrator.rst + fusiondirectory-orchestrator.rst + fusiondirectory-tools.rst argonaut-source.rst new-feature-branch.rst