feat: deprecate runserver in favor of start
#644
Merged
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
This was referenced Apr 20, 2022
kdmccormick
force-pushed
the
kdmccormick/deprecate-runserver
branch
from
a88cf20 to
4c39c1c
Compare
`tutor dev runserver` will be removed in a future release.
Developers are encouraged to use `tutor dev start` instead,
which is more flexible and provides a consistent interface
with `tutor local start`.
As part of this deprecation, we enable the `tty` and
`stdin_open` options on development docker-compose
services. This will allow developers to use `start`
for breakpoint debugging, which was previously only
availble via `runserver`. Several parallel PRs have
been merged in order to make the same change in the
development services of the official plugins.
Although `start` does not support the `--volume` option,
it supports a more-powerful `--mount` option. So, where
developers previously used:
tutor dev runserver --volume ...
to bind-mount host directories, they should now use:
tutor dev start --mount ...
Resolves openedx-unsupported/wg-developer-experience#61
kdmccormick
force-pushed
the
kdmccormick/deprecate-runserver
branch
from
4c39c1c to
830df37
Compare
|
@regisb This PR and its linked PRs are all ready for review :) |
regisb
reviewed
Apr 21, 2022
| for option in options: | ||
| if option.startswith("-v") or option.startswith("--volume"): | ||
| depr_warning += " Bind-mounts can be specified using '-m/--mount'." | ||
| fmt.echo_alert(depr_warning) |
There was a problem hiding this comment.
FYI Click has a deprecated=True option: https://click.palletsprojects.com/en/8.1.x/api/?highlight=deprecated#click.Command
This option adds "deprecated" warnings to stdout and in the command help, but it does not suggest any replacement. So your solution works just as well.
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.
Notes
Resolves openedx-unsupported/wg-developer-experience#61
Blocked by these plugin PRs:
runserverin favor ofstarttutor-mfe#46There are still a couple references to
tutor dev runserverin the official plugins, but totally scrubbing them would require moving the plugins to the V1 API and implementing theCOMPOSE_MOUNTSfilter. I figure that we can punt that work to openedx-unsupported/wg-developer-experience#26.Description
See commit message / changelog for details.
Screenshots
Deprecation warning
Deprecation warning when --volume is provided
New section in the plugin dev tutorial