Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 0.3.0 #108

Merged
merged 1 commit into from
Jul 23, 2023
Merged

Release 0.3.0 #108

merged 1 commit into from
Jul 23, 2023

Conversation

mavaylon1
Copy link
Contributor

@mavaylon1 mavaylon1 commented Jul 21, 2023

Motivation

Prepare for release of HDMF-Zarr 0.3.0

Before merging:

  • Major and minor releases: Update package versions in requirements.txt, requirements-dev.txt,
    requirements-doc.txt, requirements-min.txt, and setup.py as needed
  • Check legal file dates and information in Legal.txt, license.txt, README.rst, docs/source/conf.py,
    and any other locations as needed
  • Update setup.py as needed
  • Update README.rst as needed
  • Update changelog (set release date) in CHANGELOG.md and any other docs as needed
  • Run tests locally including gallery tests, and inspect all warnings and outputs
    (pytest && python test_gallery.py)
  • Test docs locally by going into the docs directory and running the following: make clean && make html
  • Push changes to this PR and make sure all PRs to be included in this release have been merged
  • Check that the readthedocs build for this PR succeeds (build latest to pull the new branch, then activate and
    build docs for new branch): https://readthedocs.org/projects/hdmf-zarr/builds/

After merging:

  1. Create release by following steps in docs/source/make_a_release.rst or use alias git pypi-release [tag] if set up
  2. After the CI bot creates the new release (wait ~10 min), update the release notes on the
    GitHub releases page with the changelog
  3. Check that the readthedocs "latest" and "stable" builds run and succeed
  4. Update conda-forge/hdmf_zarr-feedstock with the latest version number
    and SHA256 retrieved from PyPI > HDMF > Download Files > View hashes for the .tar.gz file. Re-render as needed

How to test the behavior?

Show how to reproduce the new behavior (can be a bug fix or a new feature)

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running ruff from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

@mavaylon1 mavaylon1 self-assigned this Jul 21, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jul 21, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (30219ba) 81.92% compared to head (92397c1) 81.92%.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #108   +/-   ##
=======================================
  Coverage   81.92%   81.92%           
=======================================
  Files          11       11           
  Lines        2667     2667           
=======================================
  Hits         2185     2185           
  Misses        482      482           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@mavaylon1
Copy link
Contributor Author

#105 documents the issue of the gallery tests not passing. I know we mentioned prior of not releasing a version with errors and from my understanding getting this fixed was to be a "project" on dev days. How do you want to proceed in terms of a release? @oruebel

@mavaylon1 mavaylon1 changed the title Update CHANGELOG.md Release 0.3.0 Jul 21, 2023
@oruebel
Copy link
Contributor

oruebel commented Jul 21, 2023

As far as I recall, the PR that introduces the error is concerned with ExternalResources and updating HDMF, but has not been merged yet, correct? If that is the case, then I would recommend we move forward with the release as is, without merging that PR, so we can get the other features that have already been merged released. We can then work on finishing that PR during the dev days.

@mavaylon1 mavaylon1 requested a review from oruebel July 22, 2023 22:17
@mavaylon1 mavaylon1 marked this pull request as ready for review July 22, 2023 22:17
@mavaylon1 mavaylon1 merged commit 9ab601f into dev Jul 23, 2023
@mavaylon1 mavaylon1 deleted the release_0.3.0 branch July 23, 2023 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants