Bumping version: 0.10.0 -> 0.11.0 (#46)

Author: tomschr

CHANGELOG.rst

@@ -20,6 +20,46 @@ Changes for the upcoming release can be found in the
 
 .. towncrier release notes start
 
+Version 0.11.0
+==============
+
+Bug Fixes
+---------
+
+- Fix #26 and add missing checks for references in stitchfile (:gh:`41`)
+- Make keys in TOML env file consistent (:gh:`43`)
+
+
+Improved Documentation
+----------------------
+
+- Improve developer documentation
+
+  * Add more glossary terms
+  * Use ``:term:`` macro to link to glossary terms
+  * Add new sections:
+    * "Bumping the Version"
+    * "Updating the Project"
+    * "Knowning the Tools Config Files"
+    * "Developing the Project"
+  * Rename "Updating Changelog" -> "Adding News Fragments"
+  * Rephrase section about IPython and :file:`devel/README.rst` (:gh:`34`)
+- Fix doc warnings from Sphinx
+
+  * Have Sphinx warnings written to :file:`docs/sphinx-warnings.log`.
+  * Disable ``inherited-members`` option (it creates warnings from a different docstring format).
+  * Slightly restructured Reference guide a bit. "Docbuild CLI" is on the top level now, making :file:`modules.rst` obsolete.
+  *  Fix some ReST problems in :file:`checks.py` docstrings (mainly missing linebreaks) (:gh:`38`)
+- Add project dependencies, add link to ``susedoc/docserv-config`` repo, and amend the glossary (:gh:`40`)
+- Rename ``issue`` macro to ``gh``
+
+
+Infrastructure
+--------------
+
+- Improve release workflow (:gh:`45`)
+
+
 Version 0.10.0
 ==============
 

changelog.d/+issue-macro.doc.rst

@@ -0,0 +1,25 @@
+.. _build-changelog:
+
+Building the Changelog
+======================
+
+The changelog is built from news fragments that are added to the repository. These fragments are collected and assembled into a changelog file for each new release.
+
+To build the changelog, make sure you have:
+
+* added news fragments (see :ref:`add-newsfragments`)
+* updated the project (see :ref:`update-project`)
+
+#. If needed, :ref:`bump the version <bump-version>`.
+#. Build the changelog file from all news fragments:
+
+   .. code-block:: shell-session
+      :caption: Build a combined changelog from news fragments
+
+      $ towncrier build [--yes]
+
+   After this command, the :file:`CHANGELOG.rst` file in the root directory is updated and all news fragments are removed from the directory :file:`changelog.d/`.
+
+#. Review the :file:`CHANGELOG.rst` file. Sometimes the changelog may not look as expected, especially if the news fragments are not formatted correctly. You can edit the file manually to fix any issues.
+
+#. Commit the :file:`CHANGELOG.rst` and the :file:`changelog.d/` directory with a message that describes the change.

changelog.d/34.doc.rst

@@ -6,28 +6,11 @@ Creating a New Release
 To create a new release, follow these steps:
 
 #. Ensure that you have the latest changes from the main branch of the repository.
-#. Create a new branch for your release. The branch name should follow the format: ``release/<VERSION>``, where ``<VERSION>`` is the version number you are releasing (e.g., ``release/1.0.0``).
+#. Create a new branch named ``release/<VERSION>``, where ``<VERSION>`` is the version number you are releasing (e.g., ``release/1.0.0``).
 #. :ref:`Bump the version <bump-version>`.
 #. :ref:`Update the project <update-project>`.
-#. Build the changelog file from all news fragments:
-
-   .. code-block:: shell-session
-      :caption: Build a combined changelog from news fragment
-
-      $ towncrier build [--yes]
-
-
-#. Commit your changes with a message that describes the release.
+#. :ref:`Build the changelog <build-changelog>`.
 #. Wait for the CI to pass. If it fails, fix the issues and commit again.
 #. If the CI passes, (squash-)merge your release branch into the main branch.
-#. Tag the commit in the ``main`` branch with the version number. The release process is triggered by this tag in the format ``MAJOR.MINOR.PATCH``.
-
-   For example, if you are releasing version 1.1.0, you would tag the commit as follows:
-
-   .. code-block:: shell-session
-      :caption: Tag the release commit
-
-       $ git tag 1.1.0
-       $ git push origin 1.1.0
-
+   The GitHub Action workflow will automatically create a new release based on the name of the release branch.
 #. Find the release in the GitHub repository under the |gh_release| section.