-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
added nox -e clean #60
Conversation
Here is the build version of the cookbook in this pull request: documentation.zip, you can view it locally by unzipping |
to clean all the temporary files in examples
Co-authored-by: Philip Loche <[email protected]>
Co-authored-by: Philip Loche <[email protected]>
With @Luthaf we were discussing of how we should call this target. clean-build seemed a good descriptive one. I'd also add docs/build, and .nox if you haven't added those already. |
I thought we did not want to add |
OK, I went through this and as far as I'm concerned, I'm happy. I separated clean_build from clean_examples, as I think people may want to keep experiments in examples sometimes, but need to clean the build. Maybe this approach gives us more flexibility to keep stuff we don't want to remove for some reason. |
for me it is fine |
Sorry if I've been mean to you, linter
@ceriottm do we want to merge this? |
Lgtm, I think I cleaned it up a while ago |
noxfile.py
Outdated
# Get the list of ignored files | ||
# Get the list of all not tracked files |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
comment seems duplicated
noxfile.py
Outdated
"""Remove temporary files and building folders""" | ||
|
||
# remove building folders and the nox cache | ||
for i in ["docs/src/examples/", "docs/build", ".nox"]: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why .nox
? this will remove itself when running =/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ceriottm I think you added that piece
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Even without michele comment I kind of agree that removing folders like .nox
is the point of this function
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm, I see this more as a way to clean temporary files created by the example, not to clean the virtualenvs. Also rm -rf .nox
is trivial compared to what nox -e clean
does, so leaving them separate is not too much of a burden on the end user.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So, the rationale for this whole PR is to have a setup similar to the clean_python script of other projects, wiping all build and caches. Upon checking, it's true that all of those don't wipe .tox so even though I added it in the first place, I now agree that for consistency we should not (or we should do this consistently everywhere). Removing it for now (and merging)
Co-authored-by: Guillaume Fraux <[email protected]>
Co-authored-by: Guillaume Fraux <[email protected]>
added nox -e clean to clean all the temporary files in examples.
followed @ceriottm discussion this is a proposal for implementing the clean function in nox.
it uses
git ls-files --other example
to check all the files not git tracked in the example dir