Devops/release notes (#2333)

* add release notes section to documentation page

* add body to gh release linking to the release notes

* update changelog

.github/RELEASE_TEMPLATE/release_body.md

@@ -0,0 +1,3 @@
+We are pleased to announce the release of a new Darts version.
+
+You can find a list with all changes in the [release notes](https://unit8co.github.io/darts/release_notes/RELEASE_NOTES.html).

.github/workflows/release.yml

@@ -73,8 +73,10 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           tag_name: ${{ steps.bump_dry.outputs.new_tag }}
-          release_name: Release ${{steps.bump_dry.outputs.part}} ${{ steps.bump_dry.outputs.new_tag }}
+          release_name: Darts ${{steps.bump_dry.outputs.part}} ${{ steps.bump_dry.outputs.new_tag }}
           draft: false
+          body_path: .github/RELEASE_TEMPLATE/release_body.md
+
 
   deploy-docker:
     needs: [release]

.gitignore

@@ -6,6 +6,7 @@ docs/source/examples
 docs/source/userguide/
 docs/source/quickstart/
 docs/source/README.rst
+docs/source/release_notes/
 docs/source/generated_api
 darts.egg-info/
 build/

CHANGELOG.md

@@ -91,10 +91,11 @@ but cannot always guarantee backwards compatibility. Changes that may **break co
   - Added a progress bar when performing optimized historical forecasts (`retrain=False` and no autoregression) to display the series-level progress.
 - Improvements to `DataTransformer`: [#2267](https://github.com/unit8co/darts/pull/2267) by [Alicja Krzeminska-Sciga](https://github.com/alicjakrzeminska).
   - `InvertibleDataTransformer` now supports parallelized inverse transformation for `series` being a list of lists of `TimeSeries` (`Sequence[Sequence[TimeSeries]]`). This `series` type represents for example the output from `historical_forecasts()` when using multiple series.
+- Other improvements:
+  - Added release notes to the Darts Documentation. [#2333](https://github.com/unit8co/darts/pull/2333) by [Dennis Bader](https://github.com/dennisbader).
 - Improvements to `RNNModel`: [#2329](https://github.com/unit8co/darts/pull/2329) by [Dennis Bader](https://github.com/dennisbader).
   - 🔴 Enforce `training_length>input_chunk_length` since otherwise, during training the model is never run for as many iterations as it will during prediction.
   - Historical forecasts now correctly infer all possible prediction start points for untrained and pre-trained `RNNModel`.
-- Improvements to linting, switch from `flake8` to Ruff: [#2323](https://github.com/unit8co/darts/pull/2323) by [Jirka Borovec](https://github.com/borda).
 
 **Fixed**
 - Fixed a bug in `quantile_loss`, where the loss was computed on all samples rather than only on the predicted quantiles. [#2284](https://github.com/unit8co/darts/pull/2284) by [Dennis Bader](https://github.com/dennisbader).
@@ -110,6 +111,7 @@ but cannot always guarantee backwards compatibility. Changes that may **break co
 - Fixed failing docs build by adding new dependency `lxml_html_clean` for `nbsphinx`. [#2303](https://github.com/unit8co/darts/pull/2303) by [Dennis Bader](https://github.com/dennisbader).
 - Bumped `black` from 24.1.1 to 24.3.0. [#2308](https://github.com/unit8co/darts/pull/2308) by [Dennis Bader](https://github.com/dennisbader).
 - Bumped `codecov-action` from v2 to v4 and added codecov token as repository secret for codecov upload authentication in CI pipelines. [#2309](https://github.com/unit8co/darts/pull/2309) and [#2312](https://github.com/unit8co/darts/pull/2312) by [Dennis Bader](https://github.com/dennisbader).
+- Improvements to linting, switch from `flake8` to Ruff: [#2323](https://github.com/unit8co/darts/pull/2323) by [Jirka Borovec](https://github.com/borda).
 
 ## [0.28.0](https://github.com/unit8co/darts/tree/0.28.0) (2024-03-05)
 ### For users of the library:

docs/Makefile

@@ -23,6 +23,7 @@ clean:
 	@rm -rf "./$(SOURCEDIR)/generated_api"
 	@rm -rf "./$(SOURCEDIR)/quickstart"
 	@rm -rf "./$(SOURCEDIR)/userguide"
+	@rm -rf "./$(SOURCEDIR)/release_notes"
 	@rm -rf "./$(SOURCEDIR)/README.rst"
 
 copy-examples:
@@ -41,6 +42,12 @@ generate-readme:
 	@m2r2 ../README.md
 	@mv ../README.rst "$(SOURCEDIR)"
 
+generate-release_notes:
+	@echo "[Makefile] generating RELEASE_NOTES rst file..."
+	@mkdir -p "$(SOURCEDIR)/release_notes"
+	@m2r2 ../CHANGELOG.md
+	@mv ../CHANGELOG.rst "$(SOURCEDIR)/release_notes/RELEASE_NOTES.rst"
+
 generate-userguide:
 	@echo "[Makefile] generating userguide rst files..."
 	@find $(USERGUIDEDIR)/*.md -exec m2r2 {} \;
@@ -58,7 +65,7 @@ html:
 	@echo "[Makefile] generating HTML pages using sphinx-build..."
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-build-all-docs: clean copy-examples copy-quickstart generate-readme generate-userguide generate-api html
+build-all-docs: clean copy-examples copy-quickstart generate-readme generate-release_notes generate-userguide generate-api html
 build-api: clean generate-api html
 
 # Catch-all target: route all unknown targets to Sphinx using the new

docs/source/index.rst

@@ -20,12 +20,16 @@
 
    API Reference<generated_api/darts>
 
-
 .. toctree::
    :hidden:
 
    Examples<examples>
 
+.. toctree::
+   :hidden:
+
+   Release Notes<release_notes/RELEASE_NOTES>
+
 
 Indices and tables
 ==================