Skip to content

Commit

Permalink
Prepare release v 0.1.0 (#60)
Browse files Browse the repository at this point in the history
  • Loading branch information
bvreede authored Jan 5, 2024
1 parent 1e943ba commit cd17c39
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 11 deletions.
17 changes: 14 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.0.1] - 1900-12-31
## [0.1.0] - 2024-01-05

### Added

- Initial release
- main modules `Corpus`, `Conversation` and `Utterance`
- parsers for `.eaf` and `.cha` files
- read and write `.json` files
- write `.csv` files
- calculate FTO in a Conversation object

### Removed

N/A

### Changed

[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
[0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1
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
19 changes: 13 additions & 6 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,28 @@ authors:
-
family-names: Gabor
given-names: Parti
-
family-names: Viviani
given-names: Eva
orcid: "https://orcid.org/0000-0002-1330-0585"
-
family-names: Dingemanse
given-names: Mark
orcid: "https://orcid.org/0000-0002-3290-5723"
date-released: 2023-03-03
-
family-names: Schnober
given-names: Carsten
orcid: "https://orcid.org/0000-0001-9139-1577"
-
family-names: De Kleijn
given-names: Maurice
-
family-names: Qi
given-names: Ji
orcid: "https://orcid.org/0000-0001-8074-2730"
date-released: 2024-01-05
doi: 10.0000/FIXME
version: "0.1.0"
repository-code: "https://github.com/elpaco-escience/scikit-talk"
keywords:
- conversation
- language corpora
- turn-taking
message: "If you use this software, please cite it using these metadata."
message: "If you use this software, please cite the original paper DOI:10.18653/v1/2021.sigdial-1.26"
license: Apache-2.0
6 changes: 4 additions & 2 deletions README.dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ This section describes how to make a release in 3 parts:
### (1/3) Preparation

1. Update the <CHANGELOG.md> (don't forget to update links at bottom of page)
1. Verify that the information in `CITATION.cff` is correct, and that `.zenodo.json` contains equivalent data
1. Verify that the information in `CITATION.cff` is correct
1. Make sure the [version has been updated](#versioning).
1. Run the unit tests with `pytest -v`

Expand All @@ -152,7 +152,8 @@ Copy the changelog for this version into the description.
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)).

Releasing on GitHub will automatically trigger the publication of the release to PyPI.
The Zenodo integration will take care of updating the Zenodo record with a new release.
Releasing on GitHub will also automatically trigger the publication of the release to PyPI, through a Github Action.
To verify that everything works as expected, it is recommended to first publish a release candidate (see [below](#release-candidates)).

> [!NOTE]
Expand All @@ -171,3 +172,4 @@ 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.

0 comments on commit cd17c39

Please sign in to comment.