feat: cleanup flag #1086
Merged
feat: cleanup flag #1086
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CodeWithEmad
force-pushed
the
feat/cleanup-flag
branch
from
dd2f8f6 to
9c82e22
Compare
|
Thanks @CodeWithEmad ! I can take a look in a couple weeks after the conference and my vacation. |
|
Thank you, @kdmccormick. There's no rush for it. Enjoy your vacation. |
DawoudSheraz
reviewed
Jul 9, 2024
CodeWithEmad
force-pushed
the
feat/cleanup-flag
branch
2 times, most recently
from
27dafaa to
9399845
Compare
kdmccormick
requested changes
Jul 17, 2024
CodeWithEmad
force-pushed
the
feat/cleanup-flag
branch
3 times, most recently
from
49dcea4 to
c2b1c19
Compare
kdmccormick
requested changes
Jul 22, 2024
CodeWithEmad
force-pushed
the
feat/cleanup-flag
branch
from
c2b1c19 to
c4c1f19
Compare
regisb
reviewed
Jul 23, 2024
regisb
reviewed
Jul 23, 2024
CodeWithEmad
force-pushed
the
feat/cleanup-flag
branch
from
c4c1f19 to
aebd3d5
Compare
CodeWithEmad
force-pushed
the
feat/cleanup-flag
branch
4 times, most recently
from
6faad48 to
70b6239
Compare
| @@ -0,0 +1 @@ | |||
| - 💥[Feature] Enhance your workflow with the new `-c` or `--clean` option for the `tutor config save` command! This feature allows you to clean your environment before each save, ensuring that all files and directories within the `env/` folder are deleted, providing you with a fresh environment each time. (by @CodeWithEmad) | |||
There was a problem hiding this comment.
It's not a breaking change. The feature is only accessible behind a new argument. we can remove 💥 from the changelog.
There was a problem hiding this comment.
+1. Also, instead of calling on all users to enhance their workflow with this new flag, could you explain why a user would want to use it? Reading #967, my understanding is this most users will not need to use -c; rather, only plugin developers or other advanced users will need it, as they are the ones who will need to clean files out of their environment.
There was a problem hiding this comment.
It's not a breaking change.
Oops. My bad.
could you explain why a user would want to use it?
How about this?
- [Feature] Added
-cor--cleanoption totutor config save: For plugin developers and advanced users, this option cleans theenv/folder before saving, ensuring a fresh environment for testing and development.
kdmccormick
approved these changes
Aug 19, 2024
This will add a `-c` `--clean` flag to the save command and ensure that the env directory is deleted if it exists. Close overhangio#967
Before this, the "Interactive platform configuration" message was shown even if -I flag was set for tutor dev|local launch.
CodeWithEmad
force-pushed
the
feat/cleanup-flag
branch
from
70b6239 to
111bb01
Compare
DawoudSheraz
approved these changes
Aug 26, 2024
|
Thanks @CodeWithEmad !! |
regisb
added a commit
that referenced
this pull request
Oct 31, 2024
The introduction of the `-c/--clean` option caused the deletion prompt to be displayed for every call to `tutor config save --interactive`. This is not the desired behaviour, as decided here: #1086 (comment) With this change, the prompt is only displayed when running: `tutor config save --interactive --clean`. The environment is still deleted on `tutor config save --clean`, but without prompt. We refactored the code with hooks, which simplifies the signature of the interactive prompt function.
regisb
added a commit
that referenced
this pull request
Nov 1, 2024
The introduction of the `-c/--clean` option caused the deletion prompt to be displayed for every call to `tutor config save --interactive`. This is not the desired behaviour, as decided here: #1086 (comment) With this change, the prompt is only displayed when running: `tutor config save --interactive --clean`. The environment is still deleted on `tutor config save --clean`, but without prompt. We refactored the code with hooks, which simplifies the signature of the interactive prompt function.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This will introduce
-c--cleancommand, to make sure we have a new environment on save.Close #967