From 889359f43e7ce685a3d701bfc0c21033d871bafa Mon Sep 17 00:00:00 2001 From: Jared Lewis Date: Tue, 14 Jan 2025 14:58:13 +1100 Subject: [PATCH 1/3] fix: Correct the changelog to use the _ separated name --- docs/changelog.md | 4 ++-- scripts/changelog-to-release-template.py | 3 +-- towncrier.toml | 2 +- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index c3dbfa0..c098670 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -21,14 +21,14 @@ from the examples given in that link. -## 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/scripts/changelog-to-release-template.py b/scripts/changelog-to-release-template.py index 50095ca..cdcc149 100644 --- 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 index f4279dc..ae59f6d 100644 --- 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})" From 0523b7a90ea2232e3d7d6ccd8e3d5a8224b13718 Mon Sep 17 00:00:00 2001 From: Jared Lewis Date: Tue, 14 Jan 2025 15:01:17 +1100 Subject: [PATCH 2/3] docs: Changelog --- changelog/61.docs.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 changelog/61.docs.md diff --git a/changelog/61.docs.md b/changelog/61.docs.md new file mode 100644 index 0000000..d67a82f --- /dev/null +++ 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. From 0b0885f4b21c57c4d4cf1c72ccdb678efc88ede3 Mon Sep 17 00:00:00 2001 From: Jared Lewis Date: Tue, 14 Jan 2025 15:06:28 +1100 Subject: [PATCH 3/3] docs: Update release docs --- README.md | 4 ++-- docs/development.md | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8f1198a..6190931 100644 --- a/README.md +++ b/README.md @@ -67,9 +67,9 @@ don't render correctly on GitHub's viewer. -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/docs/development.md b/docs/development.md index b5505e2..ec7d866 100644 --- 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