Merge pull request #61 from CMIP-REF/towncrier

CMIP-REF · Jan 14, 2025 · b0d2c90 · b0d2c90
2 parents 7b64e2d + 0b0885f
commit b0d2c90
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -67,9 +67,9 @@ don't render correctly on GitHub's viewer.
 
 <!--- --8<-- [start:description] -->
 
-CMIP Rapid Evaluation Framework can be installed with pip, mamba or conda:
+CMIP Rapid Evaluation Framework can be installed with pip, mamba or conda
+(mamba and conda releases are not yet implemented):
 
-The following commands don't work yet, but will be updated when we have a release.
 
 ```bash
 pip install cmip_ref

diff --git a/changelog/61.docs.md b/changelog/61.docs.md
@@ -0,0 +1,3 @@
+Update the package name in the changelog.
+
+This will simplify the release process by fixing the extraction of changelog entries.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -21,14 +21,14 @@ from the examples given in that link.
 
 <!-- towncrier release notes start -->
 
-## cmip-ref 0.1.5 (2025-01-13)
+## cmip_ref 0.1.5 (2025-01-13)
 
 ### Trivial/Internal Changes
 
 - [#56](https://github.com/CMIP-REF/cmip-ref/pulls/56)
 
 
-## cmip-ref 0.1.4 (2025-01-13)
+## cmip_ref 0.1.4 (2025-01-13)
 
 ### Breaking Changes
 

diff --git a/docs/development.md b/docs/development.md
@@ -195,11 +195,11 @@ The steps required are the following:
    This will then trigger a draft release.
 
 1. Edit the draft release which has been created
-   (see here:
-   [project releases](https://github.com/CMIP-REF/cmip-ref/releases)).
+   (see here: [project releases](https://github.com/CMIP-REF/cmip-ref/releases)).
    Once you are happy with the release (removed placeholders, added key
-   announcements etc.) then hit 'Publish release'. This triggers the `release` workflow to
-   PyPI (which you can then add to the release if you want).
+   announcements etc.) then hit 'Publish release'.
+   This triggers the [deploy workflow](https://github.com/CMIP-REF/cmip-ref/actions/workflows/deploy.yaml).
+   This workflow deploys the built wheels and source distributions from the release to PyPI.
 
 
 1. That's it, release done, make noise on social media of choice, do whatever

diff --git a/scripts/changelog-to-release-template.py b/scripts/changelog-to-release-template.py
@@ -14,9 +14,8 @@ def main() -> None:
     They are printed to stdout
     """
     CHANGELOG = Path("docs") / "changelog.md"
-    PACKAGE_NAME = "cmip_ref"
 
-    lead_in = f"## {PACKAGE_NAME}"
+    lead_in = "## cmip_ref"
 
     with open(CHANGELOG) as fh:
         changelog_raw = fh.read()

diff --git a/towncrier.toml b/towncrier.toml
@@ -3,7 +3,7 @@ package = "cmip_ref_core"
 package_dir = "src"
 filename = "docs/changelog.md"
 directory = "changelog/"
-title_format = "## cmip-ref {version} ({project_date})"
+title_format = "## cmip_ref {version} ({project_date})"
 underlines = ["", "", ""]
 issue_format = "[#{issue}](https://github.com/CMIP-REF/cmip-ref/pulls/{issue})"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		Update the package name in the changelog.

		This will simplify the release process by fixing the extraction of changelog entries.