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

Fix release workflow and prepare 3.10.0 release #957

Merged
merged 14 commits into from
Oct 3, 2023
Merged

Conversation

rly
Copy link
Contributor

@rly rly commented Oct 3, 2023

Motivation

Fix #956

Prepare for release of HDMF 3.10.0

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

@codecov
Copy link

codecov bot commented Oct 3, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (4377095) 88.57% compared to head (4a9c177) 88.57%.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #957   +/-   ##
=======================================
  Coverage   88.57%   88.57%           
=======================================
  Files          45       45           
  Lines        9400     9400           
  Branches     2673     2673           
=======================================
  Hits         8326     8326           
  Misses        759      759           
  Partials      315      315           

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

@rly rly changed the title Debug release issue Fix release workflow and prepare 3.9.2 release Oct 3, 2023
@rly rly changed the title Fix release workflow and prepare 3.9.2 release Fix release workflow and prepare 3.10.0 release Oct 3, 2023
@rly rly marked this pull request as ready for review October 3, 2023 07:05
@rly rly requested review from mavaylon1 and oruebel October 3, 2023 07:05
@rly rly merged commit 0c605a2 into dev Oct 3, 2023
27 of 28 checks passed
@rly rly deleted the debug_release_issue branch October 3, 2023 16:53
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.

[Bug]: Wrong Version when creating a release
2 participants