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

Prepare 4.0.0 release #1232

Merged
merged 3 commits into from
Jan 23, 2025
Merged

Prepare 4.0.0 release #1232

merged 3 commits into from
Jan 23, 2025

Conversation

rly
Copy link
Contributor

@rly rly commented Jan 17, 2025

Prepare for release of HDMF 4.0.0 on Wednesday, January 22, 2025.

Before merging:

  • Make sure all PRs to be included in this release have been merged to dev.
  • Major and minor releases: Update dependency ranges in pyproject.toml and minimums in
    requirements-min.txt 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 pyproject.toml as needed
  • Update README.rst as needed
  • Update src/hdmf/common/hdmf-common-schema submodule as needed. Check the version number and commit SHA
    manually. Make sure we are using the latest release and not the latest commit on the main branch.
  • 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). Try to remove all warnings.
  • Run PyNWB tests locally including gallery and validation tests, and inspect all warnings and outputs
    (cd pynwb; git checkout dev; git pull; python test.py -v > out.txt 2>&1)
  • Run HDMF-Zarr tests locally including gallery and validation tests, and inspect all warnings and outputs
    (cd hdmf-zarr; git checkout dev; git pull; pytest && python test_gallery.py)
  • Test docs locally and inspect all warnings and outputs cd docs; make clean && make html
  • After pushing this branch to GitHub, manually trigger the "Run all tests" GitHub Actions workflow on this
    branch by going to https://github.com/hdmf-dev/hdmf/actions/workflows/run_all_tests.yml, selecting
    "Run workflow" on the right, selecting this branch, and clicking "Run workflow". Make sure all tests pass.
  • Check that the readthedocs build for this PR succeeds (see the PR check)

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 "stable" build runs and succeeds
  4. Either monitor conda-forge/hdmf-feedstock for the
    regro-cf-autotick-bot bot to create a PR updating the version of HDMF to the latest PyPI release, usually within
    24 hours of release, or manually create a PR updating recipe/meta.yaml with the latest version number
    and SHA256 retrieved from PyPI > HDMF > Download Files > View hashes for the .tar.gz file. Re-render and
    update the dependencies as needed.

Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.87%. Comparing base (ab8cf3b) to head (682b6dc).
Report is 1 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #1232   +/-   ##
=======================================
  Coverage   90.87%   90.87%           
=======================================
  Files          42       42           
  Lines        9537     9537           
  Branches     1926     1926           
=======================================
  Hits         8667     8667           
  Misses        576      576           
  Partials      294      294           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rly rly marked this pull request as ready for review January 22, 2025 20:49
@rly rly requested a review from mavaylon1 January 22, 2025 20:49
@rly rly enabled auto-merge (squash) January 22, 2025 20:49
@rly rly merged commit b8a1a26 into dev Jan 23, 2025
60 checks passed
@rly rly deleted the prepare_4.0.0_again branch January 23, 2025 04:16
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.

2 participants