Skip to content
This repository has been archived by the owner on May 2, 2024. It is now read-only.

Deprecate 'runserver' in favor of 'start' #61

Closed
kdmccormick opened this issue Apr 19, 2022 · 3 comments · Fixed by overhangio/tutor#644
Closed

Deprecate 'runserver' in favor of 'start' #61

kdmccormick opened this issue Apr 19, 2022 · 3 comments · Fixed by overhangio/tutor#644
Assignees
Labels
enhancement Relates to new features or improvements to existing features

Comments

@kdmccormick
Copy link
Collaborator

kdmccormick commented Apr 19, 2022

Context

This does all the work discussed in #26 except actually removing the runserver command. We will complete #26 later, some time after Lisbon.

Acceptance Criteria

  • First, do: Simplify workflow for mounting repositories from host #43
  • Add tty: true and stdin_open: true to all services in tutor/templates/dev/docker-compose.yml
    • Open question: Any reason we wouldn't add it to the utility services like MySQL?
    • Open question: Would we do this for local services too?
  • For all services in official plugins as well as the plugin template:
    • Add tty: true and stdin_open: true to docker-compose-local-services patch.
  • Mark runserver as deprecated in the docs. Point to start and --mount, which replace runserver.
  • Warn on the command line that runserver is deprecated.
  • Follow-up ticket: Remove 'runserver' in favor of 'start' #26
@kdmccormick kdmccormick self-assigned this Apr 19, 2022
kdmccormick added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
It 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`.
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
Copy link
Collaborator Author

WIP: kdmccormick/tutor#9

kdmccormick added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
It 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`.
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 kdmccormick added the enhancement Relates to new features or improvements to existing features label Apr 20, 2022
@kdmccormick kdmccormick changed the title Mark 'runserver' as deprecated in favor of 'start' Deprecate 'runserver' in favor of 'start' Apr 20, 2022
kdmccormick added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
It 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 added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
It 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 added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
It 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 added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
It 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 added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
It 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 added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
It 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 added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
It 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 added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
It 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 added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
It 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 added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
`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 added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
`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 added a commit to kdmccormick/tutor that referenced this issue Apr 20, 2022
`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
Copy link
Collaborator Author

Ready for review: overhangio/tutor#644

regisb pushed a commit to overhangio/tutor that referenced this issue Apr 21, 2022
`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
Copy link
Collaborator Author

Requires merge of overhangio/tutor-mfe#46 in order to be closed

@kdmccormick kdmccormick reopened this Jun 1, 2022
@regisb regisb closed this as completed Jun 6, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement Relates to new features or improvements to existing features
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants