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 2.7.0 #1887

Merged
merged 10 commits into from
May 3, 2024
Merged

Release 2.7.0 #1887

merged 10 commits into from
May 3, 2024

Conversation

mavaylon1
Copy link
Collaborator

@mavaylon1 mavaylon1 commented Apr 10, 2024

Prepare for release of PyNWB [version]

Before merging:

  • Make sure all PRs to be included in this release have been merged to dev.
  • 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/pynwb/nwb-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, validation, and streaming tests, and inspect all warnings and outputs
    (python test.py -v -p -i -b -w -r > out.txt 2>&1). Try to remove all warnings.
  • 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/NeurodataWithoutBorders/pynwb/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/pynwb-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 > PyNWB > Download Files > View hashes for the .tar.gz file. Re-render and update
    dependencies as needed.

Copy link

codecov bot commented Apr 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.02%. Comparing base (f136410) to head (4715e63).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #1887   +/-   ##
=======================================
  Coverage   92.02%   92.02%           
=======================================
  Files          27       27           
  Lines        2620     2620           
  Branches      685      685           
=======================================
  Hits         2411     2411           
  Misses        139      139           
  Partials       70       70           
Flag Coverage Δ
integration 73.24% <ø> (ø)
unit 83.93% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@mavaylon1
Copy link
Collaborator Author

Some packages for ros3 cannot be updated to match reqs due to the fact that version is not on conda (yet).

@mavaylon1
Copy link
Collaborator Author

@stephprince When you get the chance, could you run cd docs; make clean && make html. Mine has been stuck after the third gallery file for 30 mins. I've already canceled and re-ran it twice to the same end. Let me know what you see.

@stephprince
Copy link
Contributor

cd docs; make clean && make html is working ok for me and the docs look normal

@mavaylon1 mavaylon1 requested a review from stephprince April 10, 2024 16:52
@mavaylon1 mavaylon1 self-assigned this Apr 10, 2024
@mavaylon1 mavaylon1 marked this pull request as ready for review April 10, 2024 17:03
@rly
Copy link
Contributor

rly commented Apr 10, 2024

I am going to work on #1886 today and would like to try to squeeze that into this release if possible.

@mavaylon1
Copy link
Collaborator Author

I am going to work on #1886 today and would like to try to squeeze that into this release if possible.

Works for me. Let me know if you need me to review it when you are done.

@rly
Copy link
Contributor

rly commented Apr 25, 2024

Let's get the sphinx link checker working if we can. I approved #1893

@rly
Copy link
Contributor

rly commented Apr 25, 2024

Could you or @stephprince also try to fix the macos runner issue? It’s not great to have internal tests (excluding NWB inspector tests) failing on a release. Those failures may hide other issues.

@rly
Copy link
Contributor

rly commented Apr 25, 2024

Please also wait on #1892

CHANGELOG.md Outdated Show resolved Hide resolved
environment-ros3.yml Outdated Show resolved Hide resolved
mavaylon1 and others added 2 commits May 2, 2024 15:42
Co-authored-by: Steph Prince <[email protected]>
Co-authored-by: Steph Prince <[email protected]>
@mavaylon1 mavaylon1 merged commit 86b274d into dev May 3, 2024
24 checks passed
@mavaylon1 mavaylon1 deleted the rel27 branch May 3, 2024 00:22
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