Merge pull request #1106 from xylar/fix-release-docs

Fix docs for release candidates

Author: xylar

docs/developers_guide/releasing.rst

@@ -31,16 +31,17 @@ Version Bump and Dependency Updates
 
      - ``dev-spec.txt`` (development dependencies; should be a superset)
 
-   - Use the GitHub "Compare" feature to check for dependency changes between releases:
+   - Use the GitHub "Compare" feature to check for dependency changes between
+     releases:
      https://github.com/MPAS-Dev/MPAS-Analysis/compare
 
 3. **Make a PR and merge it**
 
    - Open a PR for the version bump and dependency changes and merge once
      approved.
 
-Tagging and Publishing a Release
-================================
+Tagging and Publishing a Release Candidate
+==========================================
 
 4. **Tagging a Release Candidate**
 
@@ -66,11 +67,46 @@ Tagging and Publishing a Release
      **Note:** This will only create a tag. No release page will be created
      on GitHub.
 
-5. **Publishing a Stable Release**
+5. **Updating the conda-forge Feedstock for a Release Candidate**
+
+   - The conda-forge feedstock does **not** update automatically for release
+     candidates.
+   - You must always create a PR manually, and it must target the ``dev``
+     branch of the feedstock.
+
+   Steps:
+
+   - Download the release tarball:
+
+     ::
+
+         wget https://github.com/MPAS-Dev/MPAS-Analysis/archive/refs/tags/<version>.tar.gz
+
+   - Compute the SHA256 checksum:
+
+     ::
+
+         shasum -a 256 <version>.tar.gz
+
+   - In the ``meta.yaml`` of the feedstock recipe:
+     - Set ``{% set version = "<version>" %}``
+     - Set the new ``sha256`` value
+     - Update dependencies if needed
+
+   - Commit, push to a new branch, and open a PR **against the ``dev`` branch**
+     of the feedstock:
+     https://github.com/conda-forge/mpas-analysis-feedstock
+
+   - Follow any instructions in the PR template and merge once approved
+
+Releasing a Stable Version
+==========================
+
+6. **Publishing a Stable Release**
 
    - For stable releases, create a GitHub release page as follows:
 
-     - Go to https://github.com/MPAS-Dev/pyremap/releases
+     - Go to https://github.com/MPAS-Dev/MPAS-Analysis/releases
 
      - Click "Draft a new release"
 
@@ -83,10 +119,7 @@ Tagging and Publishing a Release
 
      - Click "Publish release"
 
-Updating the conda-forge Feedstock
-==================================
-
-6. **Automatic Feedstock Update (Preferred Method)**
+7. **Updating the conda-forge Feedstock for a Stable Release**
 
    - Wait for the ``regro-cf-autotick-bot`` to open a PR at:
      https://github.com/conda-forge/mpas-analysis-feedstock
@@ -97,34 +130,14 @@ Updating the conda-forge Feedstock
      - Confirm the version bump and dependency changes
      - Merge once CI checks pass
 
-   **Note:** If you are impatient, you can accellerate this process by creating
+   **Note:** If you are impatient, you can accelerate this process by creating
    a bot issue at: https://github.com/conda-forge/mpas-analysis-feedstock/issues
    with the subject ``@conda-forge-admin, please update version``.  This
    will open a new PR with the version within a few minutes.
 
-7. **Manual Feedstock Update (Fallback Method)**
-
-   If the bot PR does not appear or is too slow, update manually:
-
-   - Download the release tarball:
-
-     ::
-
-         wget https://github.com/MPAS-Dev/MPAS-Analysis/archive/refs/tags/<version>.tar.gz
-
-   - Compute the SHA256 checksum:
-
-     ::
-
-         shasum -a 256 <version>.tar.gz
-
-   - In the ``meta.yaml`` of the feedstock recipe:
-     - Set ``{% set version = "<version>" %}``
-     - Set the new ``sha256`` value
-     - Update dependencies if needed
-
-   - Commit, push to a new branch, and open a PR against the feedstock
-   - Follow any instructions in the PR template and merge once approved
+   - If the bot PR does not appear or is too slow, you may update manually (see
+     the manual steps for release candidates above, but target the ``main``
+     branch of the feedstock).
 
 Post Release Actions
 ====================