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 3.12 #1025

Merged
merged 10 commits into from
Jan 17, 2024
Merged

Release 3.12 #1025

merged 10 commits into from
Jan 17, 2024

Conversation

mavaylon1
Copy link
Contributor

@mavaylon1 mavaylon1 commented Jan 11, 2024

Prepare for release of HDMF [version]

Before merging:

  • Major and minor releases: Update package versions in requirements.txt, requirements-dev.txt,
    requirements-doc.txt, requirements-opt.txt, and environment-ros3.yml to the latest versions,
    and update dependency ranges in pyproject.toml and minimums in requirements-min.txt as needed.
    Run pip install pur && pur -r requirements-dev.txt -r requirements.txt -r requirements-opt.txt
    and manually update environment-ros3.yml.
  • 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
  • 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)
  • Run PyNWB tests locally including gallery and validation tests, and inspect all warnings and outputs
    (cd pynwb; 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; pytest && python test_gallery.py)
  • Test docs locally and inspect all warnings and outputs cd docs; 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/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-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

Copy link

codecov bot commented Jan 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.50%. Comparing base (9d1f378) to head (d49fc8e).
Report is 69 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #1025   +/-   ##
=======================================
  Coverage   88.50%   88.50%           
=======================================
  Files          45       45           
  Lines        9582     9582           
  Branches     2724     2724           
=======================================
  Hits         8481     8481           
  Misses        778      778           
  Partials      323      323           

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

@mavaylon1 mavaylon1 requested a review from rly January 16, 2024 17:30
@rly rly marked this pull request as ready for review January 16, 2024 17:34
@mavaylon1 mavaylon1 merged commit b4bdcef into dev Jan 17, 2024
28 checks passed
@mavaylon1 mavaylon1 deleted the rel312 branch January 17, 2024 22:18
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