diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md index 882f4313e..82f987164 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release.md +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -2,7 +2,7 @@ Prepare for release of HDMF [version] ### 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 +- [ ] 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 @@ -31,5 +31,5 @@ Prepare for release of HDMF [version] 4. Either monitor [conda-forge/hdmf-feedstock](https://github.com/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 + and SHA256 retrieved from PyPI > HDMF > Download Files > View hashes for the `.tar.gz` file. Re-render and update the dependencies as needed. diff --git a/docs/source/software_process.rst b/docs/source/software_process.rst index c4971d56e..f3a6c7457 100644 --- a/docs/source/software_process.rst +++ b/docs/source/software_process.rst @@ -45,7 +45,7 @@ pyproject.toml_ contains a list of package dependencies and their version ranges running HDMF. As a library, upper bound version constraints create more harm than good in the long term (see this `blog post`_) so we avoid setting upper bounds on requirements. -When setting lower bounds, make sure to specify the lower bounds in both pyproject.toml_ and +When setting lower bounds, make sure to specify the lower bounds in both pyproject.toml_ and requirements-min.txt_. The latter is used in automated testing to ensure that the package runs correctly using the minimum versions of dependencies. @@ -64,7 +64,7 @@ Testing Requirements pyproject.toml_ contains the optional dependency group "test" with testing requirements. -See tox.ini_ and the GitHub Actions workflows for how different testing environments are +See tox.ini_ and the GitHub Actions workflows for how different testing environments are defined using the optional dependency groups. environment-ros3.yml_ lists the dependencies used to test ROS3 streaming in HDMF which diff --git a/tox.ini b/tox.ini index 0a506cab2..897842155 100644 --- a/tox.ini +++ b/tox.ini @@ -22,7 +22,7 @@ install_command = minimum, wheelinstall: python -I -m pip install {opts} {packages} upgraded: python -I -m pip install -U {opts} {packages} prerelease: python -I -m pip install -U --pre {opts} {packages} -deps = +deps = # which requirements files to use (default: none) minimum: -r requirements-min.txt extras =