Skip to content

Commit

Permalink
[MRG] minor fixes to release behavior (#2479)
Browse files Browse the repository at this point in the history
Minor fixes after #2386 -

* be more specific about what to look for on RTD;
* package `CITATION.cff` in source distributions so that
`test_citation_file` works.
  • Loading branch information
ctb committed Feb 20, 2023
1 parent 75605ea commit b08ac03
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions doc/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ A convenient way to edit release notes is to put them in a [hackmd.io](https://h
## Testing a release

0\. First things first: check if Read the Docs is building properly for `latest`.
The build on [Read the Docs] should be passing,
and also check if the [rendered docs] are updated.
The build for the `latest` branch on [Read the Docs] should be passing,
and also the [rendered docs] should be up to date.

[Read the Docs]: https://readthedocs.org/projects/sourmash/builds/
[rendered docs]: https://sourmash.readthedocs.io/en/latest/
Expand All @@ -98,13 +98,13 @@ git checkout -b release/v${new_version}
```
and update the version number in `pyproject.toml` and `flake.nix`:
```
sed -i -e "s|version = .*$|version = \"${new_version}${rc}\"|g" pyproject.toml flake.nix
sed -i -e "s|version = .*$|version = \"${new_version}\"|g" pyproject.toml flake.nix
```

Commit the changes and push the branch:
```
git add pyproject.toml
git commit -m "${new_version} release candidate ${rc}"
git add pyproject.toml flake.nix
git commit -m "${new_version} release"
git push -u origin release/v${new_version}
```
and then open a PR for the new branch by following the link printed by
Expand Down Expand Up @@ -160,8 +160,8 @@ cd ../../../testenv3/
deactivate
source bin/activate
python -m pip install sourmash*tar.gz
tar xzf sourmash-${new_version}${rc}.tar.gz
cd sourmash-${new_version}${rc}
tar xzf sourmash-${new_version}.tar.gz
cd sourmash-${new_version}
python -m pip install -r requirements.txt
cp -a ../../sourmash/tests/test-data tests/ ## We don't ship the test data, so let's copy it here
pytest && cargo test
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ include = [
{ path = "requirements.txt", format = ["sdist"] },
{ path = "Cargo.*", format = ["sdist"] },
{ path = "tests/*.py", format = ["sdist"] },
{ path = "citation.cff", format = ["sdist", "wheel"] },
{ path = "CITATION.cff", format = ["sdist", "wheel"] },
]
features = ["maturin"]
locked = true
Expand Down

0 comments on commit b08ac03

Please sign in to comment.