rustworkx icon indicating copy to clipboard operation
rustworkx copied to clipboard

Replace Tox with Nox

Open IvanIsCoding opened this issue 1 year ago • 3 comments

Closes #852

We replace Tox with Nox, overall it seems promising. I do think customizing Nox seems much, much easier given that we have the full power of Python. In fact, I feel we could profit and replace many items in tools/ too with Nox in the future

IvanIsCoding avatar Apr 14 '23 16:04 IvanIsCoding

Pull Request Test Coverage Report for Build 8470603505

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.01%) to 96.514%

Totals Coverage Status
Change from base Build 8468454020: 0.01%
Covered Lines: 17138
Relevant Lines: 17757

💛 - Coveralls

coveralls avatar Apr 14 '23 18:04 coveralls

Sorry for the super slow review on this, I'm super keen to get us off of tox. I took a quick look through the config and it looks reasonable to me and this looks great, and is much nicer than what we had with tox. I still need to checkout the branch locally and play with it to see how it works in practice for me.

The one thing I think we should avoid doing for this commit is to keep the tox.ini file around for a little bit. Just because we've been using it since the creation of retworkx so leaving the config around for a while and maybe adding python -c print("The use of tox for running tests is no longer supported in a future version of rustworkx you should use nox instead. Refer to the contributing guide for more details on it's usage") to the tox jobs. I'm just worried about the occasional contributor that comes back after 5 months and tries to run tox and gets frustrated.

I'll delete the tox.ini file and add a "legacy" tox.ini to pyproject.toml with the error messages you said

IvanIsCoding avatar Sep 02 '23 18:09 IvanIsCoding

@mtreinish I think this ready for review, I addressed the comments

IvanIsCoding avatar Sep 12 '23 03:09 IvanIsCoding

I pushed up a small commit to add back the tox.ini file in it's previous form and add the warning to the end of the ouptut. I think it's better to not actively break developer's existing workflows, but just make it explicit we're not supporting it anymore. The cost of keeping the tox.ini file around in the short to medium term is minimal.

I am thinking about wrap the current workflows around nox them i.e. make tox only install nox and then call nox -e test for example

IvanIsCoding avatar Mar 28 '24 18:03 IvanIsCoding