Skip to content

Commit

Permalink
Release v0.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
h-mayorquin committed Aug 30, 2024
1 parent 9bef89f commit 66ab8b8
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 14 deletions.
10 changes: 2 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,9 @@
# Upcoming

### Deprecations

### Features
## v0.6.1 (August 30, 2024)

### Bug fixes
* Fixed the JSON schema inference warning on excluded fields; also improved error message reporting of which method
triggered the error. [PR #1037](https://github.com/catalystneuro/neuroconv/pull/1037)

### Improvements

* Fixed the JSON schema inference warning on excluded fields; also improved error message reporting of which method triggered the error. [PR #1037](https://github.com/catalystneuro/neuroconv/pull/1037)

## v0.6.0 (August 27, 2024)

Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@
[![License](https://img.shields.io/pypi/l/neuroconv.svg)](https://github.com/catalystneuro/neuroconv/license.txt)

<p align="center">
<img src="https://github.com/catalystneuro/neuroconv/blob/main/docs/img/neuroconv_logo.png" width="250" alt="NeuroConv logo"/>
<img src="https://raw.githubusercontent.com/catalystneuro/neuroconv/main/docs/img/neuroconv_logo.png" width="250" alt="NeuroConv logo"/>
<h3 align="center">Automatically convert neurophysiology data to NWB</h3>
</p>

<p align="center">
<a href="https://neuroconv.readthedocs.io/"><strong>Explore our documentation »</strong></a>
</p>
Expand Down
10 changes: 5 additions & 5 deletions docs/developer_guide/making_a_release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,23 @@ A simple to-do list for the Neuroconv release process:

- Format and update the changelog.
- Ensure correct formatting and add a header to indicate that the changes belong to a specific release and not upcoming ones.
- Example: `Commit Example <https://github.com/catalystneuro/neuroconv/commit/2fbea8f05e5bd92c445fcbb6bf24de45330fcbbc>`_
- Example: `Commit Example <https://github.com/catalystneuro/neuroconv/commit/2fbea8f05e5bd92c445fcbb6bf24de45330fcbbc>`

2. **Set the Correct Version for Release**:

- The development version (the current code on `main`) should be one patch version ahead of the latest PyPI release and therefore ready for the next step.
- If a minor version bump is necessary, change it accordingly.
- Example: `Version Change Example <https://github.com/catalystneuro/neuroconv/commit/af91f09f300cb36ba4fee483196c8cb492c180ae>`_
- Example: `Version Change Example <https://github.com/catalystneuro/neuroconv/commit/af91f09f300cb36ba4fee483196c8cb492c180ae>`

3. **Perform Checks**:

- Ensure that no requirement files include pointers to `git`-based dependencies (including specific branches or commit hashes). All dependencies for a PyPI release should point to the released package versions that are available on conda-forge or PyPI.
- Ensure that no requirement files include pointers to `git`-based dependencies (including specific branches or commit hashes). All dependencies for a PyPI release should point to the released package versions that are available on conda-forge or PyPI. This can be done efficiently by searching for `@ git` in an IDE.

4. **Tag on GitHub**:

- The title and tag should be the release version.
- The changelog should be copied correspondingly.
- Check the hashes in the markdown to ensure they match with the format of previous releases. This can be done efficiently by searching for `@ git` in an IDE.
- Check the hashes in the markdown to ensure they match with the format of previous releases.

5. **Release**:

Expand All @@ -32,4 +32,4 @@ A simple to-do list for the Neuroconv release process:
6. **Bump Version Post-Release**:

- To comply with the one patch version ahead policy, bump the version after the release.
- Example: `Post-Release Version Bump <https://github.com/catalystneuro/neuroconv/commit/89d5e41f5140c3aa1ffa066974befb21c7a01567>`_
- Example: `Post-Release Version Bump <https://github.com/catalystneuro/neuroconv/commit/89d5e41f5140c3aa1ffa066974befb21c7a01567>`

0 comments on commit 66ab8b8

Please sign in to comment.