From d2a59e09f6cb8e2b3293773f9a6b5705d8c120c8 Mon Sep 17 00:00:00 2001 From: Barbara Vreede Date: Fri, 5 Jan 2024 17:43:53 +0100 Subject: [PATCH] Update DOI and make fixes for PyPI release (#61) --- .bumpversion.cfg | 2 +- .github/workflows/publish-pypi.yml | 4 ++-- CHANGELOG.md | 8 ++++++-- CITATION.cff | 4 ++-- README.dev.md | 3 ++- README.md | 2 +- docs/conf.py | 2 +- setup.cfg | 2 +- sktalk/__init__.py | 2 +- 9 files changed, 17 insertions(+), 12 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 6fa4c06..15333eb 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.1.0 +current_version = 0.1.1 [comment] comment = The contents of this file cannot be merged with that of setup.cfg until https://github.com/c4urself/bump2version/issues/185 is resolved diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml index 03b62f7..694768b 100644 --- a/.github/workflows/publish-pypi.yml +++ b/.github/workflows/publish-pypi.yml @@ -32,7 +32,7 @@ jobs: publish-to-pypi: name: >- Publish Python 🐍 distribution 📦 to PyPI - if: startsWith(github.ref, 'refs/tags/') && !contains(github.ref, 'rc')" # only publish to PyPI on tag pushes that do not contain 'rc' + if: startsWith(github.ref, 'refs/tags/') && !contains(github.ref, 'rc') # only publish to PyPI on tag pushes that do not contain 'rc' needs: - build runs-on: ubuntu-latest @@ -52,7 +52,7 @@ jobs: publish-to-testpypi: name: Publish Python 🐍 distribution 📦 to TestPyPI - if: "startsWith(github.ref, 'refs/tags') && contains(github.ref, 'rc')" # only publish to PyPI on tag pushes with 'rc' (release candidate) label + if: startsWith(github.ref, 'refs/tags') && contains(github.ref, 'rc') # only publish to PyPI on tag pushes with 'rc' (release candidate) label needs: - build runs-on: ubuntu-latest diff --git a/CHANGELOG.md b/CHANGELOG.md index 01af9a9..59d6c48 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,15 @@ # Changelog + All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] +## [0.1.1] - 2024-01-05 + +### Added + +- DOI links to the Zenodo archive ## [0.1.0] - 2024-01-05 @@ -25,5 +30,4 @@ N/A N/A -[Unreleased]: https://github.com/elpaco-escience/scikit-talk/compare/v0.1.0...HEAD [0.1.0]: https://github.com/elpaco-escience/scikit-talk/releases/tag/v0.1.0 diff --git a/CITATION.cff b/CITATION.cff index ec4df22..afa0926 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -30,8 +30,8 @@ authors: given-names: Ji orcid: "https://orcid.org/0000-0001-8074-2730" date-released: 2024-01-05 -doi: 10.0000/FIXME -version: "0.1.0" +doi: 10.5281/zenodo.10462997 +version: "0.1.1" repository-code: "https://github.com/elpaco-escience/scikit-talk" keywords: - conversation diff --git a/README.dev.md b/README.dev.md index 0b78df5..284c9ca 100644 --- a/README.dev.md +++ b/README.dev.md @@ -172,4 +172,5 @@ To verify that everything works as expected, it is recommended to first publish 1. Confirm that the released package can be installed - from PyPI with `pip install scikit-talk` - from test.PyPI with `pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/test-scikit-talk` -1. The release should have triggered a [Zenodo upload](https://zenodo.org/). Confirm that the Zenodo record has been updated. +1. The release should have triggered a [Zenodo upload](https://zenodo.org/doi/10.5281/zenodo.10462997). Confirm that the Zenodo record has been updated. + diff --git a/README.md b/README.md index d719788..9b4540d 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ | (1/5) code repository | [![github repo badge](https://img.shields.io/badge/github-repo-000.svg?logo=github&labelColor=gray&color=blue)](git@github.com:elpaco-escience/scikit-talk) | | (2/5) license | [![github license badge](https://img.shields.io/github/license/elpaco-escience/scikit-talk)](git@github.com:elpaco-escience/scikit-talk) | | (3/5) community registry | [![RSD](https://img.shields.io/badge/rsd-scikit-talk-00a3e3.svg)](https://www.research-software.nl/software/scikit-talk) [![workflow pypi badge](https://img.shields.io/pypi/v/scikit-talk.svg?colorB=blue)](https://pypi.python.org/project/scikit-talk/) | -| (4/5) citation | [![DOI](https://zenodo.org/badge/DOI/.svg)](https://doi.org/) | +| (4/5) citation | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10462997.svg)](https://doi.org/10.5281/zenodo.10462997) | | (5/5) checklist | [![workflow cii badge](https://bestpractices.coreinfrastructure.org/projects//badge)](https://bestpractices.coreinfrastructure.org/projects/) | | howfairis | [![fair-software badge](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow)](https://fair-software.eu) | | **Other best practices** |   | diff --git a/docs/conf.py b/docs/conf.py index 02e5e8b..f57a7f3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,7 +26,7 @@ # built documents. # # The short X.Y version. -version = "0.1.0" +version = "0.1.1" # The full version, including alpha/beta/rc tags. release = version diff --git a/setup.cfg b/setup.cfg index 098723e..cde908b 100644 --- a/setup.cfg +++ b/setup.cfg @@ -26,7 +26,7 @@ name = scikit-talk project_urls = Bug Tracker = https://github.com/elpaco-escience/scikit-talk/issues url = https://github.com/elpaco-escience/scikit-talk -version = 0.1.0 +version = 0.1.1 [options] zip_safe = False diff --git a/sktalk/__init__.py b/sktalk/__init__.py index 9880eef..309b54b 100644 --- a/sktalk/__init__.py +++ b/sktalk/__init__.py @@ -10,4 +10,4 @@ __author__ = "Barbara Vreede" __email__ = "b.vreede@esciencecenter.nl" -__version__ = "0.1.0" +__version__ = "0.1.1"