Skip to content

Commit

Permalink
Update DOI and make fixes for PyPI release (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
bvreede committed Jan 5, 2024
1 parent cd17c39 commit d2a59e0
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/publish-pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion README.dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<replace-with-created-DOI>.svg)](https://doi.org/<replace-with-created-DOI>) |
| (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/<replace-with-created-project-identifier>/badge)](https://bestpractices.coreinfrastructure.org/projects/<replace-with-created-project-identifier>) |
| 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** | &nbsp; |
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion sktalk/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@

__author__ = "Barbara Vreede"
__email__ = "b.vreede@esciencecenter.nl"
__version__ = "0.1.0"
__version__ = "0.1.1"

0 comments on commit d2a59e0

Please sign in to comment.