Changelog#
v0.10.0: Version 0.10.0#
Released on 2023-08-25 - GitHub - PyPI
This release adds support for running on multiple repositories at once. You can list as many as you need, and the output formats will be modified to better support multiple repos. You can also now filter out passing or passing + skipped checks, which is especially useful in long multi-repo reports. You can also pass the path to pyproject.toml
instead of just the repo if it's at top-level.
Due to issues with Rich adding spaces and wrapping (which breaks JSON) even when not interactive, JSON and HTML output is no longer pretty-printed.
Features:
--show
err
only orerrskip
only by @henryiii in #132- Allow passing the path to pyroject.toml by @henryiii in #133
- Allow running on multiple directories at once by @henryiii in #134
Fixes:
- Drop Rich color printout for html & JSON by @henryiii in #135
- Support
*
for select by @henryiii in #138
Docs:
- Add mention of recent features by @henryiii in #137
- Add mention of pre-commit issues by @henryiii in #139
Full Changelog: v0.9.3...v0.10.0
v0.9.3: Version 0.9.3#
Released on 2023-08-23 - GitHub - PyPI
This release adds support for [tool.repo-review]
to validate-pyproject.
Features:
Internal:
Docs:
- Add some info about making tests for plugins by @henryiii in #120
- Add more links and some updates by @henryiii in #122
- Fix links in README by @henryiii in #126
- Ddd validate-pyproject by @henryiii in #129
Full Changelog: v0.9.2...v0.9.3
v0.9.2: Version 0.9.2#
Released on 2023-08-03 - GitHub - PyPI
A few fixes, one for a regression and one for the WebApp.
Fixes:
- Span wasn't set properly in the WebApp by @henryiii in #119
- Pass correct self object by @henryiii in #118
Full Changelog: v0.9.1...v0.9.2
v0.9.1: Version 0.9.1#
Released on 2023-08-03 - GitHub - PyPI
Quick WebApp fix for Pyodide having pyyaml 6.0.0.
Fixes:
Full Changelog: v0.9.0...v0.9.1
v0.9.0: Version 0.9#
Released on 2023-08-03 - GitHub - PyPI
This release adds a new description
slot that is shown below the family name if present. You can request fixtures in the family collection function now, which allows the descriptions to be dynamic, based on the repo being evaluated. A minor breaking change is also present - the text return from checks is no longer run through .format
, removing the need for escaping. A new checks-only fixture name
is provided in case you did need the current check name.
Features:
- Drop formatting of dynamic messages, add "name" fixture by @henryiii in #115
- Family descriptions and dynamic families by @henryiii in #114
Fixes:
Docs and other:
- Link to source in docs by @henryiii in #106
- Use sphinx-autobuild by @henryiii in #109
- Drop PyTest Python 3.12 workaround by @henryiii in #110
Full Changelog: v0.8.1...v0.9.0
v0.8.1: Version 0.8.1#
Released on 2023-07-13 - GitHub - PyPI
This release fixes a couple of issues with the webapp; it now supports pressing "enter" to move, and error messages (which hopefully you never see!) will get formatted nicely.
Fixes:
Full Changelog: v0.8.0...v0.8.1
v0.8.0: Version 0.8.0#
Released on 2023-06-29 - GitHub - PyPI
This release adds a new fixture (list_all
, a bool), several new helper functions (get_check_url
, get_check_description
, get_family_name
), and makes collect_all
part of the public API, with a structured return. This enables easier programatic usage, especially when listing all (unevaluated) checks. This is use for a new new cog example in a new documentation page on programmatic usage.
Features:
Full Changelog: v0.7.0...v0.8.0
v0.7.0: Version 0.7.0#
Released on 2023-06-17 - GitHub - PyPI
This is the first stand-alone release after being split out from sp-repo-review
and moved to scientific Python.
Features:
- feat:
--list-all
rename and improvements,--version
addition by @henryiii in #96 - feat: add
--list
to show all checks by @henryiii in #83 - feat: add Composite Action by @henryiii in #45
- feat: add pre-commit support by @henryiii in #48
- feat: add select by @henryiii in #75
- feat: allow name sub in URL by @henryiii in #80
- feat: dynamic error messages by @henryiii in #70
- feat: exit codes by @henryiii in #76
- feat: selection for output by @henryiii in #87
- feat: support for URLs by @henryiii in #72
- feat: support root / package dir seperation by @henryiii in #71
- refactor: rename and split by @henryiii in #68
- refactor: rename err_markdown to err_as_html by @henryiii in #99
- refactor: stderr/stdout by @henryiii in #95
Fixes:
- fix: URL visible in results by @henryiii in #77
- fix: corrections while adding docs by @henryiii in #78
- fix: stderr never has format codes by @henryiii in #90
- fix: update webapp and tests for sp-repo-review by @henryiii in #81
- fix: webapp details by @henryiii in #85
- fix: webapp supports setting dependencies by @henryiii in #82
Other things:
- chore: auto-versioning by @henryiii in #89
- chore: bump sp-repo-review version by @henryiii in #97
- ci: prepare dist by @henryiii in #73
- docs: fill out some API docs by @henryiii in #98
- docs: add changelog by @henryiii in #100
- docs: add docs by @henryiii in #74
- docs: add version number by @henryiii in #92
- docs: add version number by @henryiii in #93
- docs: add version number by @henryiii in #94
- docs: filling out a bit more by @henryiii in #79
- docs: link to live preview. by @henryiii in #84
- docs: minor fixes by @henryiii in #91
- docs: some getting started info by @henryiii in #86
Full Changelog: v0.6.1...v0.7.0
v0.7.0b10: Version 0.7.0 beta 10#
Released on 2023-06-14 - GitHub - PyPI
Renaming a confusing method before release.
Full Changelog: v0.7.0b9...v0.7.0b10
v0.7.0b9: Version 0.7.0 beta 9#
Released on 2023-06-13 - GitHub - PyPI
- chore: bump sp-repo-review version by @henryiii in #97
- docs: Fill out some API docs by @henryiii in #98
Full Changelog: v0.7.0b8...v0.7.0rc1
v0.7.0b8: Version 0.7.0 beta 8#
Released on 2023-06-07 - GitHub - PyPI
Features:
- stderr/stdout refactor by @henryiii in #95
--list-all
rename and improvements, --version addition by @henryiii in #96
Full Changelog: v0.7.0b7...v0.7.0b8
v0.7.0b7: Version 0.7.0 beta 7#
Released on 2023-06-07 - GitHub - PyPI
This release improves the PyPI landing page a little, and touches up the docs with better versioning.
Documentation:
- minor fixes by @henryiii in #91
- add version number by @henryiii in #92
- add version number by @henryiii in #93
- add version number by @henryiii in #94
(GitHub was having an outage)
Full Changelog: v0.7.0b6...v0.7.0b7
v0.7.0b6: Version 0.7.0 beta 6#
Released on 2023-06-07 - GitHub - PyPI
Features:
- Add pre-commit support by @henryiii in #48
- Add Composite Action by @henryiii in #45
- Rework selection for output by @henryiii in #87 and #90
Other:
Full Changelog: v0.7.0b5...v0.7.0b6
v0.7.0b5: Version 0.7.0 beta 5#
Released on 2023-06-07 - GitHub - PyPI
Features:
- Add
--list
to show all checks by @henryiii in #83 - Webapp supports setting dependencies by @henryiii in #82
Other:
- Update webapp and tests for
sp-repo-review
by @henryiii in #81 - Link to live preview in docs by @henryiii in #84
- Touch up some webapp details by @henryiii in #85
Full Changelog: v0.7.0b4...v0.7.0b5
v0.7.0b4: Version 0.7.0 beta 4#
Released on 2023-06-05 - GitHub - PyPI
Features:
Full Changelog: v0.7.0b3...v0.7.0b4
v0.7.0b3: Version 0.7.0 beta 3#
Released on 2023-06-05 - GitHub - PyPI
Features:
Fixes:
Docs:
Full Changelog: v0.7.0b2...v0.7.0b3
v0.7.0b2: Version 0.7.2 beta 2#
Released on 2023-06-04 - GitHub - PyPI
Adding a few more features before release of scientific-python version. Split root/package, add URL support, and support dynamic error messages.
Features:
- feat: dynamic error messages by @henryiii in #70
- feat: support root / package dir seperation by @henryiii in #71
- feat: support for URLs by @henryiii in #72
Other:
Full Changelog: v0.7.0b1...v0.7.0b2
v0.7.0b1: Version 0.7.0b1#
Released on 2023-06-04 - GitHub - PyPI
Full Changelog: v0.6.1...v0.7.0b1
v0.6.1: Version 0.6.1#
Released on 2023-06-01 - GitHub - PyPI
Fix a regression in 0.6.0 with error messages not showing up, and also improve the output formatting a bit by removing the extra paragraph tag.
What's Changed
Fixes:
- Produce the correct error message by @henryiii in #66
- Strip paragraph tags when converting to markdown by @henryiii in #67
Full Changelog: v0.6.0...v0.6.1
v0.6.0: Version 0.6.0#
Released on 2023-06-01 - GitHub - PyPI
This version has a lot of internal rewrites, preparing it for splitting up into a general runner and a specific tool, as discussed at the Scientific-Python Developer Summit. This is likely the last release before the split.
What's Changed
Features:
- feat: add families by @henryiii in #62
- feat: add html output option by @henryiii in #58
- feat: adding ignores by @henryiii in #49
- feat: json format output & a fix by @henryiii in #47
- feat: request from github by @henryiii in #56
- feat: simplify result for json by @pllim in #46
- feat: topological graph for fixtures, too by @henryiii in #60
Refactoring:
- refactor: 'checks' in json output to save space for later additions by @henryiii in #61
- refactor: checks as objects by @henryiii in #63
- refactor: entry points by @henryiii in #52
- refactor: move functions to files that make more sense by @henryiii in #65
- refactor: rating -> check unified language by @henryiii in #57
- refactor: rework families by @henryiii in #55
Other:
- chore: Add devcontainer by @crazy4pi314 in #44
- chore: add 3.12 to classifiers by @henryiii in #59
- chore: bump version by @henryiii in #64
- fix(dev): devcontainer post create by @henryiii in #54
New Contributors
- @crazy4pi314 made their first contribution in #44
- @pllim made their first contribution in #46
Full Changelog: v0.5.1...v0.6.0
v0.5.1: Version 0.5.1#
Released on 2023-05-16 - GitHub - PyPI
Small release fixing a check that was reporting fail instead of skip if Ruff config was not present.
Now using trusted publisher PyPI deployment, too.
What's Changed
Full Changelog: v0.5.0...v0.5.1
v0.5.0: Version 0.5.0#
Released on 2023-02-22 - GitHub - PyPI
Moved from various other style checkers to Ruff, following the Scikit-HEP developer guidelines and scikit-hep/cookie.
What's Changed
Full Changelog: v0.4.2...v0.5.0
v0.4.2: Version 0.4.2#
Released on 2023-02-22 - GitHub - PyPI
Small release moving to using Ruff internally (next release will move to using Ruff). Also fixed a potential issue with Python 3.11 requiring tomli.
What's Changed
- chore(deps): update pre-commit hooks by @pre-commit-ci in #16
- ci: update to Python 3.11 final by @henryiii in #18
- chore: move to using Ruff by @henryiii in #22
- chore(deps): bump pypa/gh-action-pypi-publish from 1.5.1 to 1.6.4 by @dependabot in #21
New Contributors
- @pre-commit-ci made their first contribution in #16
Full Changelog: v0.4.1...v0.4.2
v0.4.1: Version 0.4.1#
Released on 2022-09-30 - GitHub - PyPI
Small update that mostly adds Python 3.11 testing & a pyodide update for the docs. For development, PyTest is now expected to be 7+, since we aren't testing with <7.
What's Changed
Full Changelog: v0.4.0...v0.4.1
v0.4.0: Version 0.4.0#
Released on 2022-08-19 - GitHub - PyPI
This release changes to the new dependabot best practice of not limiting official versions, since it now handles v1->v2 instead of v1->v2.0.0. It also adds a check for test naming.
What's Changed
-
feat: Add 'name-tests-test' to pre-commit hooks by @matthewfeickert in #9
-
fix(webapp): show changed URL when running by @henryiii in #6
-
chore(deps): bump pre-commit/action from 2.0.3 to 3.0.0 by @dependabot in #7
-
chore(deps): bump actions/setup-python from 3 to 4 by @dependabot in #8
-
chore(deps): bump pypa/gh-action-pypi-publish from 1.5.0 to 1.5.1 by @dependabot in #12
New Contributors
- @matthewfeickert made their first contribution in #9
Full Changelog: v0.3.0...v0.4.0
v0.3.0: Version 0.3.0#
Released on 2022-05-13 - GitHub - PyPI
First version under the scikit-hep org. Added two new checks (prettier, blacken-docs), which also are applied to this codebase (repo-review self-checks fully passing). Fixed several bugs - filter warnings was misreporting, and bugbear didn't work if you pinned bugbear.
What's Changed
Full Changelog: v0.2.4...v0.3.0
v0.2.4: Version 0.2.4#
Released on 2022-04-29 - GitHub - PyPI
Updates to the web app, like the ability to pre-fill the fields with ?repo=...&branch=...
. The web app now prints [skipped]
as well. The app now passes its own tests. Lots of documentation updates to the checks, and several fixes for the checks.
Full Changelog: v0.2.3...v0.2.4
v0.2.3: Version 0.2.3#
Released on 2022-04-19 - GitHub - PyPI
Minor updates to error messages, also correcting a skip issue with GHA.
v0.2.2: Version 0.2.2#
Released on 2022-04-15 - GitHub - PyPI
Integrating webapp Python code for simpler usage.
Full Changelog: v0.2.1...v0.2.2
v0.2.1: Version 0.2.1#
Released on 2022-04-14 - GitHub - PyPI
Fix for skipping checks.
Full Changelog: v0.2.0...v0.2.1