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

feat!: Rename branches master->release, nightly->next #1153

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kdmccormick
Copy link
Collaborator

@kdmccormick kdmccormick commented Nov 7, 2024

TEP: https://discuss.openedx.org/t/tep-rename-nightly-next-and-master-release/12994

GitHub issue: #1096

We also incorporate the IS_NIGHTLY suggestion from this rejected bugfix PR, under the name IS_NEXT, as a reliable way of determining whether to patch for Tutor Release or Tutor Next.

To Do before merging:

  • Queue up PRs for the other core plugins
  • Make sure Edly is ready to update the GitLib pipelines
  • Make sure Regis is ready to rename the branch in GitHub
  • Maybe: Wait until after the Sumac release on Dec 9?

Immediately after merging:

  • Merge this same commit into Next (the auto-sync may be temporarily broken at this point)
  • Rebase this PR and merge it into Next: feat!: Change version suffix from 'nightly' to 'next' #1154
  • Merge the core plugin PRs
  • Merge: feat: Add "next" index (and symlink "nightly" to it) tpi#6
  • Edly: Merge GitLab pipline updates
  • Regis: Rename branches in GitHub
  • Put an announcement in the forums, x-posted to Slack, explaining how Nightly devs can migrate to Next:
    tutor dev stop
    OLD_ROOT="$(tutor config printroot)"
    git branch -m nightly next
    git switch next
    git pull
    NEW_ROOT=$(tutor config printroot)"
    mv "$OLD_ROOT" "$NEW_ROOT"`
    tutor config save

@@ -91,7 +91,7 @@ If that does not work, then check if there are any other Docker containers runni

docker ps -a

For example, if you have ever used :ref:`Tutor Nightly <nightly>`, check whether there are still ``tutor_nightly_`` containers running. Conversely, if trying to run Tutor Nightly now, check whether there are non-Nightly ``tutor_`` containers running. If so, switch to that other version of Tutor, run ``tutor (dev|local|k8s) stop``, and then switch back to the preferred version of Tutor.
For example, if you have ever used :ref:`Tutor Next <next>`, check whether there are still ``tutor_next`` containers running. Conversely, if trying to run Tutor Next now, check whether there are non-Next ``tutor_`` containers running. If so, switch to that other version of Tutor, run ``tutor (dev|local|k8s) stop``, and then switch back to the preferred version of Tutor.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example, if you have ever used :ref:`Tutor Next <next>`, check whether there are still ``tutor_next`` containers running. Conversely, if trying to run Tutor Next now, check whether there are non-Next ``tutor_`` containers running. If so, switch to that other version of Tutor, run ``tutor (dev|local|k8s) stop``, and then switch back to the preferred version of Tutor.
For example, if you have ever used :ref:`Tutor Next <next>`, check whether there are still ``tutor_next_`` containers running. Conversely, if trying to run Tutor Next now, check whether there are non-Next ``tutor_`` containers running. If so, switch to that other version of Tutor, run ``tutor (dev|local|k8s) stop``, and then switch back to the preferred version of Tutor.

typo

@@ -64,6 +64,7 @@ def _prepare_environment() -> None:
("HOST_USER_ID", utils.get_user_id()),
("TUTOR_APP", __app__.replace("-", "_")),
("TUTOR_VERSION", __version__),
("IS_NEXT", tutor.__about__.__app__.__version_suffix__ == "next"),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have an issue with the "IS_NEXT" name, which is not very explicit. Maybe "IS_ON_NEXT_BRANCH"? Or "IS_NEXT_VERSION"?

Also, we can simplify this line to __app__.__version_suffix__ == "next".

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@regisb How about just TUTOR_NEXT ? It's not very explicit either, but since "Tutor Next" will be an established term in the docs (like "Tutor Nightly" is now), I think that a user looking at a boolean variable named TUTOR_NEXT will be able to deduce the meaning.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

2 participants