Skip to content

Commit

Permalink
patch v2.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
jmccreight committed Dec 19, 2024
1 parent 856ac8e commit 4377790
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 25 deletions.
10 changes: 7 additions & 3 deletions .github/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,16 @@ To release a new version:
`v{major}.{minor}.{patch}` ([semantic version](https://semver.org/) number
with a leading 'v'). For instance, for a minor release, if this repo is an
`upstream` remote and one's local `develop` is up to date with upstream
`develop`, then from `develop` run `git switch -c vx.y.z`.
`develop`, then from `develop` run `git switch -c vx.y.z`.

1. If this is a patch release, make changes/fixes locally. If this is a major or
minor release, no changes may be needed. In either case, add the release version
and date to the top of `doc/whats-new.rst`. If a patch, put it below the
pending minor release. Also update the version in `doc/index.rst`. Update the
CITATION.cff file. If a major release, get the provisional new DOI from USGS
and add it to CITATION.cff and the main README.md.
and add it to CITATION.cff and the top-level README.md. If the release is
approved, put the disclaimer for approved releases onthe top-level README.md.
Otherwise keep the provisional disclaimer.

1. Push the branch to this repo. For instance, if this repo is an `upstream`
remote: `git push -u upstream vx.y.z`. This starts a job to:
Expand Down Expand Up @@ -103,13 +105,15 @@ To release a new version:

1. In the case of a minor or major release, (a patch would be applied to both
main and develop?) a couple of manual steps:
- Check out `main` as a new branch to get it back into develop,
- Check out `main` as a new branch in order to get it back into develop,
eg feat_main_to_dev.
- Run `.github/scripts/update_version.py -v x.y+1.0.dev0` to update
`version.txt` and `pywatershed/version.py` with the minor version number
incremented. The `.dev0` suffix indicates preliminary development status.
- Add a new minor release to the top of `doc/whats-new.rst`
- Incorporate the ASV details from the previous section above.
- If main was an approved release, revert the disclaimer on the top-level
README.md to the provisional disclaimer.
- Open a PR against `develop` with the updated version files and the
updates previously merged to `main`.

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ jobs:
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: 3.10
python-version: "3.10"
cache: 'pip'
cache-dependency-path: pyproject.toml

Expand Down
30 changes: 9 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,27 +153,15 @@ guidelines.
Thank you for your interest.

## How to Cite
McCreight, J., Langevin, C. D., Hughes, J. D., & Bonelli, W. P. (2024). pywatershed (Version 2.0.0) [Computer software]. [https://doi.org/10.5066/P13EWPEV](https://doi.org/10.5066/P13EWPEV)

McCreight, J. L., Langevin, C. D., Hughes, J. D., & Bonelli, W. P. (2024). pywatershed (Version 2.0.0) [Computer software]. [https://doi.org/10.5066/P13EWPEV](https://doi.org/10.5066/P13EWPEV)

## Disclaimer

This information is preliminary or provisional and is subject to revision. It is
being provided to meet the need for timely best science. The information has not
received final approval by the U.S. Geological Survey (USGS) and is provided on
the condition that neither the USGS nor the U.S. Government shall be held liable
for any damages resulting from the authorized or unauthorized use of the
information.

From: https://www2.usgs.gov/fsp/fsp_disclaimers.asp#5

This software is in the public domain because it contains materials that
originally came from the U.S. Geological Survey, an agency of the United States
Department of Interior. For more information, see the [official USGS copyright
policy](https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits
"official USGS copyright policy")

Although this software program has been used by the USGS, no warranty, expressed
or implied, is made by the USGS or the U.S. Government as to the accuracy and
functioning of the program and related program material nor shall the fact of
distribution constitute any such warranty, and no responsibility is assumed by
the USGS in connection therewith. This software is provided "AS IS."
This software has been approved for release by the U.S. Geological Survey (USGS). Although the
software has been subjected to rigorous review, the USGS reserves the right to update the
software as needed pursuant to further analysis and review. No warranty, expressed or implied,
is made by the USGS or the U.S. Government as to the functionality of the software and related
material nor shall the fact of release constitute any such warranty. Furthermore, the software
is released on condition that neither the USGS nor the U.S. Government shall be held liable
for any damages resulting from its authorized or unauthorized use.

0 comments on commit 4377790

Please sign in to comment.