Merge pull request #303 from tpvasconcelos/release-notes

Update release process notes

docs/development/release_process.md

@@ -9,7 +9,12 @@ You need to have push-access to the project's repository to make releases. There
 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.,
+3. **IMPORTANT:** Remember to switch to the `main` branch and pull the latest changes before proceeding.
+   ```shell
+   git switch main
+   git pull
+   ```
+4. 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
    # MAJOR release (e.g., 0.4.2 -> 1.0.0)
    SKIP='no-commit-to-branch' bumpversion major
@@ -24,14 +29,14 @@ You need to have push-access to the project's repository to make releases. There
    ```shell
    bumpversion --dry-run --verbose [--allow-dirty] [major,minor,patch]
    ```
-4. **DANGER:** Push your changes along with the new git tag to the remote repository.
+5. **DANGER:** Push your changes along with the new git tag to the remote repository.
    ```shell
    git push --follow-tags
    ```
-5. At this point, a couple of GitHub Actions workflows will be triggered:
+6. At this point, a couple of GitHub Actions workflows will be triggered:
     1. {repo-file}`.github/workflows/ci.yml`: Runs all integration approval checks.
     2. {repo-file}`.github/workflows/release.yml`: Builds and publishes the new packaged Python distributions to PyPi (and TestPyPi) and publishes a new GitHub Release with relevant release notes and Sigstore-certified built distributions.
-6. **Trust but verify!** ⚠️
+7. **Trust but verify!** ⚠️
     1. Verify that all workflows [run successfully](https://github.com/tpvasconcelos/ridgeplot/actions);
     2. Verify that the new git tag [is present](https://github.com/tpvasconcelos/ridgeplot/tags) in the remote repository;
     3. Verify that the new release [is present](https://github.com/tpvasconcelos/ridgeplot/releases) in the remote repository;

docs/reference/changelog.md

@@ -13,7 +13,7 @@ Unreleased changes
 
 - 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`)
+- Update release process notes ({gh-pr}`301` and {gh-pr}`303`)
 
 ### CI/CD