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.6.0 #861

Merged
merged 2 commits into from
May 12, 2023
Merged

Release 3.6.0 #861

merged 2 commits into from
May 12, 2023

Conversation

mavaylon1
Copy link
Contributor

@mavaylon1 mavaylon1 commented May 12, 2023

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-min.txt, requirements-opt.txt, environment-ros3.yml, 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 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)
  • 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/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

@mavaylon1 mavaylon1 changed the title Update CHANGELOG.md Release 3.6.0 May 12, 2023
@mavaylon1
Copy link
Contributor Author

mavaylon1 commented May 12, 2023

@rly I thought there were enough changes to warrant the release being 3.6.0 instead of 3.5.6.

@codecov
Copy link

codecov bot commented May 12, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (60a46d4) 88.21% compared to head (15d1fe9) 88.21%.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #861   +/-   ##
=======================================
  Coverage   88.21%   88.21%           
=======================================
  Files          44       44           
  Lines        9020     9020           
  Branches     2576     2576           
=======================================
  Hits         7957     7957           
  Misses        752      752           
  Partials      311      311           

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

@mavaylon1 mavaylon1 requested a review from rly May 12, 2023 01:31
@mavaylon1 mavaylon1 merged commit 8a3fc19 into dev May 12, 2023
@mavaylon1 mavaylon1 deleted the release_3.6.0 branch May 12, 2023 02:20
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.

None yet

2 participants