Skip to content

Commit

Permalink
Remove bench results
Browse files Browse the repository at this point in the history
  • Loading branch information
benjeffery authored and mergify[bot] committed Aug 26, 2022
1 parent 42fbc5f commit 1ad7ac6
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 10,777 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
build-gcc
.DS_Store
python/benchmark/*.trees
python/benchmark/*.json
python/benchmark/*.html

13 changes: 6 additions & 7 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -1145,15 +1145,14 @@ GitHub issue milestone of the release.

### Python

To make a release first prepare a pull request that sets the correct version
number in `tskit/_version.py` following PEP440 format. For a normal release
It is worth running the benchmarks as above before release to check for any unexpected
major regressions. To make a release first prepare a pull request that sets the correct
version number in `tskit/_version.py` following PEP440 format. For a normal release
this should be MAJOR.MINOR.PATCH, for a beta release use MAJOR.MINOR.PATCHbX
e.g. 1.0.0b1. Update the Python CHANGELOG.rst, ensuring that all significant
changes since the last release have been listed. Comparing
`git log --follow --oneline -- python`
with `git log --follow --oneline -- python/CHANGELOG.rst` may help here.
Once the version number is updated run the benchmarks as detailed above and
commit the `bench-results.json/html` files.
Once this PR is merged, push a tag to github:

```bash
Expand All @@ -1170,6 +1169,6 @@ Publishing this release will cause the github
action to deploy to the [production PyPI](https://pypi.org/project/tskit/).
After release, start a section in the changelog for new developments, close the
GitHub issue milestone of the release and update ROADMAP.md.



For a major release the website (github repo tskit-dev/tskit-site) should then
be updated with a notebook of new features. The benchmarks should be run as above
and the `bench-results.html` updated on the website.
Loading

0 comments on commit 1ad7ac6

Please sign in to comment.