Release v0.1.0 (#142)

Co-authored-by: Abel Soares Siqueira <[email protected]>
Co-authored-by: Olga Lyashevska <[email protected]>

CHANGELOG.md

@@ -6,13 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.0.1] - 1900-12-31
+## [0.1.0] - 2023-11-28
 
-### Added
+- First release.
 
-### Removed
-
-### 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
+<!-- markdown-link-check-disable -->
+[Unreleased]: https://github.com/point-cloud-radar/bird-cloud-gnn/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/point-cloud-radar/bird-cloud-gnn/releases/tag/v0.1.0

CITATION.cff

@@ -1,5 +1,6 @@
 # This CITATION.cff file was generated with cffinit.
 # Visit https://bit.ly/cffinit to generate yours today!
+
 cff-version: 1.2.0
 title: bird-cloud-gnn
 message: >-
@@ -17,9 +18,21 @@ authors:
     email: [email protected]
     affiliation: Netherlands eScience Center
     orcid: 'https://orcid.org/0000-0003-4451-281X'
+  - given-names: Bart
+    email: [email protected]
+    family-names: Kranstauber
+    affiliation: University of Amsterdam
+    orcid: 'https://orcid.org/0000-0001-8303-780X'
+  - given-names: 'Bart '
+    family-names: Hoekstra
+    email: [email protected]
+    affiliation: University of Amsterdam
+    orcid: 'https://orcid.org/0000-0002-7085-3805'
 repository-code: 'https://github.com/point-cloud-radar/bird-cloud-gnn'
 keywords:
   - point cloud
   - graph neural network
   - bird identification
 license: Apache-2.0
+version: 0.1.0
+date-released: '2023-11-28'

README.dev.md

@@ -105,7 +105,7 @@ The documentation will be in `docs/_build/html`
 If you do not have `make` use
 
 ```shell
-sphinx-build -b html docs docs/_build/html
+sphinx-build -b html docs/ docs/_build/html
 ```
 
 To find undocumented Python objects run
@@ -123,16 +123,6 @@ cd docs
 make doctest
 ```
 
-## Versioning
-
-Bumping the version across all files is done with [bumpversion](https://github.com/c4urself/bump2version), e.g.
-
-```shell
-bumpversion major
-bumpversion minor
-bumpversion patch
-```
-
 ## Making a release
 
 This section describes how to make a release in 3 parts:
@@ -144,8 +134,8 @@ 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)
-2. Verify that the information in `CITATION.cff` is correct, and that `.zenodo.json` contains equivalent data
-3. Make sure the [version has been updated](#versioning).
+2. Verify that the information in `CITATION.cff` is correct
+3. Make sure the version has been updated in `bird_cloud_gnn/__init__.py`, `setup.cfg`, and `docs/conf.py`
 4. Run the unit tests with `pytest -v`
 
 ### (2/3) PyPI