From 5ddf104379bbc1f06d056ccc0dba6f8ccedbc885 Mon Sep 17 00:00:00 2001 From: Barbara Vreede Date: Wed, 1 Dec 2021 15:29:39 +0100 Subject: [PATCH] update contribution guidelines and prepare for v1.3.1 (#106) * add info about release candidate * more release candidate info * update version number * update changelog * add dash to version tag Co-authored-by: Stefan Verhoeven * remove RSD Co-authored-by: Stefan Verhoeven * consistently use release candidate Co-authored-by: Stefan Verhoeven Co-authored-by: Stefan Verhoeven --- CHANGELOG.rst | 4 ++++ CITATION.cff | 2 +- CONTRIBUTING.md | 23 ++++++++++++++++------- era5cli/__version__.py | 2 +- 4 files changed, 22 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a8f5ba6..68eadca 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,6 +1,10 @@ Release Notes ************* +1.3.1 (2021-12-01) +~~~~~~~~~~~~~~~~~~ +* Automatic Zenodo/RSD release failed; updated contribution guidelines `#106 `_ + 1.3.0 (2021-11-30) ~~~~~~~~~~~~~~~~~~ * Fix compatibility with changed CDS variables geopotential/orography `#98 `_ diff --git a/CITATION.cff b/CITATION.cff index 1a077f5..edbb43b 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -87,4 +87,4 @@ license: Apache-2.0 message: "If you use this software, please cite it using these metadata." repository-code: "https://github.com/ewatercycle/era5cli" title: era5cli -version: 1.3.0 +version: 1.3.1 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f75af1..cb723bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,8 @@ Ensure all authors are present in: - `era5cli/__version__.py` ## Confirm release info -Ensure the right date and upcoming version number is set in: +Ensure the right date and upcoming version number (including release candidate +tag, if applicable) is set in: - `CITATION.cff` - `era5cli/__version__.py` @@ -35,17 +36,25 @@ that the description is in Markdown, so reformat from Rst if necessary). Tag the release according to [semantic versioning guidelines](https://semver.org/), preceded with a `v` (e.g.: v1.0.0). The release title is the tag and the release date together (e.g.: v1.0.0 -(2019-07-25)). Tick the pre-release box in case the release is a candidate -release, and amend the version tag with `rc` and the candidate number. +(2019-07-25)). + +### Release candidate +When releasing a release candidate on Github, tick the pre-release box, and +amend the version tag with `-rc` and the candidate number. Ensure the release +candidate version is accurate in `CITATION.cff` and `era5cli/__version__.py`. +If the version number in these files is not updated, Zenodo release +workflows will fail. + +Releasing a release candidate is not required, but can help detect bugs early. ## PyPI release workflow Publishing a new release in github triggers the github Action workflow that builds and publishes the package to test.PyPI or PyPI. Versions with "rc" -(releasecandidate) in their version tag will only be published to test.PyPI. -Other version tags will trigger a PyPI release. -Inspect `.github/workflows/publish-to-pypi.yml` for more information. +(release candidate) in their version tag will only be published to test.PyPI. +Other version tags will trigger a PyPI release. Inspect +`.github/workflows/publish-to-pypi.yml` for more information. -Confirm a pre-release on test.PyPI with: +Confirm a release candidate on test.PyPI with: ``` pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ era5cli ``` diff --git a/era5cli/__version__.py b/era5cli/__version__.py index e214cbc..6b9a8ef 100644 --- a/era5cli/__version__.py +++ b/era5cli/__version__.py @@ -12,4 +12,4 @@ 'Peter Kalverla', 'Barbara Vreede', 'Aytaç Paçal', 'Stef Smeets', 'Stefan Verhoeven') __email__ = 'ewatercycle@esciencecenter.nl' -__version__ = '1.3.0' +__version__ = '1.3.1'