exasol · Nicoretti · Mar 13, 2024 · Feb 9, 2024 · Feb 9, 2024 · Feb 9, 2024
diff --git a/.github/workflows/build-and-publish.yml b/.github/workflows/build-and-publish.yml
@@ -34,4 +34,5 @@ jobs:
         run: >
           gh release create ${GITHUB_REF_NAME}
           --title ${GITHUB_REF_NAME}
+          --notes-file ./doc/changes/changes_${GITHUB_REF_NAME}.md
           dist/*
diff --git a/doc/changelog.rst b/doc/changelog.rst
diff --git a/doc/changes/changelog.md b/doc/changes/changelog.md
@@ -0,0 +1,30 @@
+# 📝 Changes
+
+* [unreleased](unreleased.md)
+* [0.8.0](changes_0.8.0.md)
+* [0.7.0](changes_0.7.0.md)
+* [0.6.2](changes_0.6.2.md)
+* [0.6.1](changes_0.6.1.md)
+* [0.6.0](changes_0.6.0.md)
+* [0.5.0](changes_0.5.0.md)
+* [0.4.0](changes_0.4.0.md)
+* [0.3.0](changes_0.3.0.md)
+* [0.2.0](changes_0.2.0.md)
+* [0.1.0](changes_0.1.0.md)
+
+```{toctree}
+---
+hidden:
+---
+unreleased
+changes_0.8.0
+changes_0.7.0
+changes_0.6.2
+changes_0.6.1
+changes_0.6.0
+changes_0.5.0
+changes_0.4.0
+changes_0.3.0
+changes_0.2.0
+changes_0.1.0
+```
diff --git a/doc/changes/changes_0.1.0.md b/doc/changes/changes_0.1.0.md
@@ -0,0 +1,5 @@
+# 0.1.0 - 2022-11-25
+
+## Added
+
+* ✨ Initial release
diff --git a/doc/changes/changes_0.2.0.md b/doc/changes/changes_0.2.0.md
@@ -0,0 +1,12 @@
+# 0.2.0 - 2022-12-20
+
+## ✨ Added
+* Added basic templates for workflow and config files
+* Added additional Project metadata
+
+## 🔧 Changed
+* Updated dependencies
+* Migrate project to exasol organization
+
+## 📚 Documentation
+* Updated workflow documentation
diff --git a/doc/changes/changes_0.3.0.md b/doc/changes/changes_0.3.0.md
@@ -0,0 +1,7 @@
+# 0.3.0 - 2022-12-21
+
+## ✨ Added
+* Added support for custom path filters to config object
+
+## 🔧 Changed
+* Updated dependencies
diff --git a/doc/changes/changes_0.4.0.md b/doc/changes/changes_0.4.0.md
@@ -0,0 +1,16 @@
+# 0.4.0 - 2023-04-19
+
+## ✨ Added
+* Added support for metrics
+    - Added nox metrics task :code:`nox -s report`
+    - Added GitHub workflow which generates and reports the metrics
+    - Added metrics workflow call invocation to standard workflows
+        * ci
+        * ci-cd
+        * pr-merge
+
+## 🔧 Changed
+* Updated dependencies
+
+## 🗑 Removed
+* Removed :code:`scriv` support
diff --git a/doc/changes/changes_0.5.0.md b/doc/changes/changes_0.5.0.md
@@ -0,0 +1,10 @@
+# 0.5.0 - 2023-10-12
+
+## ✨ Added
+* Added first version of the tbx cli tool with support for managing github workflows
+
+## 🔧 Changed
+* Changed autogenerated comment in version.py for better clarity
+* Updated dependencies
+* Updated github issue templates
+
diff --git a/doc/changes/changes_0.6.0.md b/doc/changes/changes_0.6.0.md
@@ -0,0 +1,6 @@
+# 0.6.0 - 2023-10-27
+
+## ✨ Added
+* Added security command
+* Added security-issues action
+
diff --git a/doc/changes/changes_0.6.1.md b/doc/changes/changes_0.6.1.md
@@ -0,0 +1,5 @@
+# 0.6.1 - 2023-10-27
+
+## 🐞 Fixed
+* Fixed failing security-issues action in case of empty ignore list
+
diff --git a/doc/changes/changes_0.6.2.md b/doc/changes/changes_0.6.2.md
@@ -0,0 +1,9 @@
+# 0.6.2 - 2023-11-20
+
+## 🐞 Fixed
+* Fix failing vulnerability issue creator when Maven report does not contain "vulnerable" entry
+
+## 🔧 Changed
+* Update pylint dependency
+* Update import-lib dependency
+
diff --git a/doc/changes/changes_0.7.0.md b/doc/changes/changes_0.7.0.md
@@ -0,0 +1,5 @@
+# 0.7.0 - 2024-01-26
+
+## ✨ Added
+* Added support for referencing projects in security-issues action.
+
diff --git a/doc/changes/changes_0.8.0.md b/doc/changes/changes_0.8.0.md
@@ -0,0 +1,5 @@
+# 0.8.0 - 2024-02-07
+
+## ✨ Added
+* Added output `created-issues` to `security-issues` action containing the found security issues including the created GitHub issues in JSONL format.
+
diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md
@@ -0,0 +1,40 @@
+# Unreleased
+
+## 🚨 Breaking Changes
+* **CI-CD Workflow (Breaking Change)**
+
+    **Overview:**
+
+    The CI-CD workflow now assumes the changelog to be in markdown and the location `/doc/changes/change_x.y.z.md`
+
+## ✨ Added
+* **Added Nox Task `prepare-release`**
+
+    **Overview:**
+
+    A new Nox task, `prepare-release`, has been introduced to streamline the release preparation process. This task automates several crucial steps:
+
+    - Create a dedicated branch for the release changes.
+    - Transfer changes from the "Unreleased" section to the appropriate versioned changelog section.
+    - Update the version number to the next release.
+    - Initiate a Pull Request (PR) for review and integration into the main branch.
+
+    **Usage:**
+
+    To prepare a release, simply execute a command in your terminal like in the example below:
+
+    ```shell
+    nox -s prepare-release -- 1.10.1
+    ```
+
+    Add the changes for releasing on top of the current branch:
+
+    ```shell
+    nox -s prepare-release -- 1.10.1 --no-pr --no-branch
+    ```
+
+    For additional options and help regarding the task `prepare-release`, execute:
+
+    ```shell
+    nox -s prepare-release -- -h 
+    ```
diff --git a/doc/conf.py b/doc/conf.py
@@ -35,6 +35,7 @@
     "sphinx.ext.autosummary",
     "sphinx.ext.autosectionlabel",
     "sphinx_copybutton",
+    "myst_parser",
 ]
 
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}

diff --git a/doc/developer_guide/development.rst b/doc/developer_guide/development.rst
@@ -1,48 +1,45 @@
 🚧 Development - Contributing
 =============================
 
-Setting up the Development Environment
-++++++++++++++++++++++++++++++++++++++
+Creating a Release
+++++++++++++++++++
 
-.. figure:: ../_static/nothing-to-see-here.png
-    :alt: nothing to see here
-    :target: https://imgflip.com/i/2a7gqa
+Prepare the Release
+-------------------
 
-    source: `imgflip.com <https://imgflip.com/>`_
+To prepare for a release, a pull request with the following parameters needs to be created:
 
-Creating a Release
-++++++++++++++++++
+- Updated version numbers
+- Updated the changelog
+- Updated workflow templates (not automated yet)
+
+This can be achieved by running the following command:
 
-Prerequisites
--------------
+.. code-block:: shell
 
-* Change log needs to be up to date
-* Latest change log version needs to match project and package version
-* Release tag needs to match package, changelog and project version
+   nox -s prepare-release -- <major>.<minor>.<patch>
 
-  For Example:
-        * Tag: 0.4.0
-        * Changelog: changes_0.4.0.md
-        * \`poetry version -s\`: 0.4.0
+Replace `<major>`, `<minor>`, and `<patch>` with the appropriate version numbers.
+Once the PR is successfully merged, the release can be triggered (see next section).
 
 Triggering the Release
 ----------------------
-In order to trigger a release a new tag must be pushed to Github.
-For further details see: `.github/workflows/ci-cd.yml`.
 
+To trigger a release, a new tag must be pushed to GitHub. For further details, see `.github/workflows/ci-cd.yml`.
 
-#. Create a local tag with the appropriate version number
+1. Create a local tag with the appropriate version number:
 
     .. code-block:: shell
 
         git tag x.y.z
 
-#. Push the tag to Github
+2. Push the tag to GitHub:
 
     .. code-block:: shell
 
         git push origin x.y.z
 
+
 What to do if the release failed?
 ---------------------------------
 

diff --git a/doc/index.rst b/doc/index.rst
@@ -9,4 +9,4 @@
    github_actions/github_actions
    api
    developer_guide/developer_guide
-   changelog
+   changes/changelog