Merge pull request #301 from tpvasconcelos/release-notes

Update release process and changelog

Author: tpvasconcelos

docs/development/release_process.md

@@ -6,24 +6,25 @@
 You need to have push-access to the project's repository to make releases. Therefore, the following release steps are intended to be used as a reference for maintainers or [collaborators](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-personal-account-repository#collaborator-access-for-a-repository-owned-by-a-personal-account) with push-access to the repository.
 :::
 
-1. Review the `## Unreleased changes` section in {repo-file}`docs/reference/changelog.md` by checking for consistency in format and, if necessary, refactoring related entries into relevant subsections (e.g., _Features_, _Docs_, _Bugfixes_, _Security_, etc.). Take a look at previous release notes for guidance and try to keep it consistent.
-2. Submit a pull request with these changes only and use the `"Cleanup release notes for X.X.X release"` template for the pull request title. ridgeplot uses the [SemVer](https://semver.org/) (`MAJOR.MINOR.PATCH`) versioning standard. You can determine the latest release version by running `git describe --tags --abbrev=0` on the `main` branch. Based on this, you can determine the next release version by incrementing the MAJOR, MINOR, or PATCH. More on this in the next section. Remember to merge this pull request into the `main` branch before continuing to the next step!
-3. Use the [bumpversion](https://github.com/peritus/bumpversion) utility to bump the current version. This utility will automatically bump the current version, and apply a relevant commit and git tag. E.g.,
+1. Review the **`## Unreleased changes`** section at the top of the {repo-file}`docs/reference/changelog.md` file and, if necessary, group and/or split entries into relevant subsections (e.g., _Features_, _Docs_, _Bugfixes_, _Security_, etc.). Take a look at previous release notes for guidance and try to keep the format consistent.
+2. Review new usages of `.. versionadded::`, `.. versionchanged::`, and `.. deprecated::` directives that were added to the documentation since the last release. If necessary, update the version numbers in these directives to reflect the new release version.
+   * You can determine the latest release version by running `git describe --tags --abbrev=0` on the `main` branch. Based on this, you can determine the next release version by incrementing the relevant _MAJOR_, _MINOR_, or _PATCH_ numbers.
+3. Use the [bumpversion](https://github.com/peritus/bumpversion) utility to automatically bump the current version, apply a relevant changes to the repository, and create a new commit and git tag. E.g.,
    ```shell
-   # Bump MAJOR version (e.g., 0.4.2 -> 1.0.0)
+   # MAJOR release (e.g., 0.4.2 -> 1.0.0)
    SKIP='no-commit-to-branch' bumpversion major
 
-   # Bump MINOR version (e.g., 0.4.2 -> 0.5.0)
+   # MINOR release (e.g., 0.4.2 -> 0.5.0)
    SKIP='no-commit-to-branch' bumpversion minor
 
-   # Bump PATCH version (e.g., 0.4.2 -> 0.4.3)
+   # PATCH release (e.g., 0.4.2 -> 0.4.3)
    SKIP='no-commit-to-branch' bumpversion patch
    ```
    You can always perform a dry-run to see what will happen under the hood.
    ```shell
    bumpversion --dry-run --verbose [--allow-dirty] [major,minor,patch]
    ```
-4. Push your changes along with the new git tag to the remote repository.
+4. **DANGER:** Push your changes along with the new git tag to the remote repository.
    ```shell
    git push --follow-tags
    ```

docs/reference/changelog.md

@@ -9,14 +9,17 @@ Unreleased changes
 
 - Improve type annotations and use stricter pyright settings ({gh-pr}`291`)
 
-### CI/CD
-
-- Fix regressions tests by comparing against JSON artefacts instead of flaky JPEGs ({gh-pr}`299`)
-
 ### Documentation
 
 - Use `sphinxcontrib.apidoc` to automatically generate API docs from the source code ({gh-pr}`296`)
 - Update hero image in the docs' landing page ({gh-pr}`300`)
+- Update release process notes ({gh-pr}`301`)
+
+### CI/CD
+
+- Fix regressions tests by comparing against JSON artefacts instead of flaky JPEGs ({gh-pr}`299`)
+
+Thanks to {gh-user}`imprvhub` for their contributions to this release! 🚀
 
 ---