Skip to content
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

build: NIGHTLY ONLY: install nightly branches of official plugins #626

Merged
merged 1 commit into from
Apr 11, 2022

Conversation

kdmccormick
Copy link
Collaborator

@kdmccormick kdmccormick commented Apr 5, 2022

Description

This fixes openedx-unsupported/wg-developer-experience#41. Before this PR, Tutor Nightly users needed to install all the official plugins by hand (unlike Tutor Stable users, who have the plugins bundled in for them). After this PR, simply running pip install -e "./tutor[full]" on the nightly branch will install Tutor Nightly as well as Nightly versions of all plugins

Documentation changes have been made in a separate PR, so that they can be merged to master and reflected on the official documentation site as soon as this is merged to nightly: #631

Testing

From Tutor's nightly branch:

pip uninstall --yes tutor-discovery tutor-mfe  # Or any other plugins
tutor plugins list # Should be missing tutor-discovery and tutor-mfe
pip install -e ".[full]"
tutor plugins list # Should now include tutor-discovery and tutor-mfe
pip freeze | grep "tutor-"  # All official plugins should be git-installed (except for tutor-license)

Notes

A couple questions for you @regisb . From the first commit's message:

  • Unlike other plugins, tutor-license is still installed from PyPI, but without any version constraint. This is because tutor-license is a simple, closed-source plugin which activates Wizard edition for subscribers. It should be available in Nightly but doesn't need to be installed from its own bleeding-edge branch.

This ^ is just my best guess on how tutor-license should be installed for Nightly. Let me know if I should do something differently.

  • Unlike most nightly commits, this commit should NOT ever be
    reflected on master. When it comes time to merge nightly into
    master during the release of Nutmeg, this commit will need to
    be manually reverted from master.

Do I have this right?

@kdmccormick
Copy link
Collaborator Author

@regisb This one's ready for review!

@kdmccormick kdmccormick changed the title feat(nightly): install nightly branches of official plugins In Tutor Nightly, install nightly branches of official plugins Apr 6, 2022
For Tutor Nightly (and only Nightly), official plugins are now installed
from their nightly branches on GitHub instead of a version range on
PyPI. This will allow Nightly users to install all official plugins by
running:

    pip install -e ".[full]"

Notes:
  * We use the syntax `EGG @ git+REPO@nightly` because the
    more common syntax of `git+REPO@nightly#egg=EGG` does not work
    when supplied to setup.py's extras_require.
  * Unlike other plugins, tutor-license is still installed from PyPI,
    but without any version constraint. This is because tutor-license
    is a simple, closed-source plugin which activates Wizard edition
    for subscribers. It should be available in Nightly but doesn't
    need to be installed from its own bleeding-edge branch.
  * Unlike most nightly commits, this commit should NOT ever be
    reflected on master. When it comes time to merge nightly into
    master during the release of Nutmeg, this commit will need to
    be manually reverted from master.
  * Documentation updates have been made separately so that they
    can be merged into master.
@kdmccormick kdmccormick changed the title In Tutor Nightly, install nightly branches of official plugins build: NIGHTLY ONLY: install nightly branches of official plugins Apr 8, 2022
kdmccormick added a commit to kdmccormick/tutor that referenced this pull request Apr 8, 2022
The full installation will include all the plugins that
come bundled with Tutor stable. This is made possible by
a recent change to Tutor Nightly
(overhangio#626).
@regisb regisb merged commit 698f498 into overhangio:nightly Apr 11, 2022
@kdmccormick kdmccormick deleted the kdmccormick/nightly-plugins branch April 11, 2022 16:59
regisb pushed a commit that referenced this pull request Apr 15, 2022
The full installation will include all the plugins that
come bundled with Tutor stable. This is made possible by
a recent change to Tutor Nightly
(#626).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants