Tutor branches rename

[DawoudSheraz]

This issue is to track the implementation/changes proposed in https://discuss.openedx.org/t/tep-rename-nightly-main-and-master-release/12994.

• Update branch names in tutor core and plugins
  • nightly --> next nightly --> main
  • master --> release
• Ensure github workflows are updated to represent the new branch naming
• Ensure the GitLab build pipelines are upgraded to ensure releases and sync work as expected

[kdmccormick]

The Core PRs for this are ready:

• feat!: Rename branches master->release, nightly->main #1153
• Change version suffix to 'main' and load plugins from their main branches #1154
• Add Main index (and symlink Nightly to it) & Point at main plugin branches tpi#6

If you like those PRs @regisb and @DawoudSheraz , then I can start asking plugin maintainers to make PRs. Once the plugin PRs and the Edly-internal PRs are ready, we can merge all at once, and then Regis can change the branch names in GitHub.

I'm willing to make that happen before Sumac release, but I'm also willing to wait if it seems like too much change during the release testing phase.

[regisb]

I'm happy with those PRs, thanks for opening them Kyle. But shouldn't they target the "nightly" branches? It's a major breaking change, after all. EDIT: this was a very silly suggestion. Since we are renaming the master branch as well, we should update the release docs.

If necessary I can make the s/nightly/next/g sed replacements in plugins and push straight to the git repos.

Let's push this change before Sumac.

[DawoudSheraz]

Should we hold on until sumac? The original proposal to do it with Sumac was because upstream branches would be renamed as well. Since they are not renamed yet, we can wait until sumac. We can do this first thing after sumac. I am ok with merging it before too.

[regisb]

I think we should make that change before we release tutor v19.0.0. Otherwise we are going to find ourselves with a big, risky change to merge in a very short time.

[kdmccormick]

If necessary I can make the s/nightly/next/g sed replacements in plugins and push straight to the git repos.

I would not oppose that!

As far as I can tell, those PRs will simply be documentation updates. The timing of them is not so sensitive.

But shouldn't they target the "nightly" branches? It's a major breaking change, after all.

Right, uhhh, stepping back... it seems that we have seven things to coordinate:

1. The Sumac release on Dec 09
2. The big Tutor PR, which affects docs, GH workflows, and the setting of OPENEDX_COMMON_VERSION.
3. The version-suffix Tutor PR, which just changes tutor_nightly to tutor_next
4. The core branch renaming in overhangio/tutor GitHub settings, which only a repo admin (not I) can do.
5. The plugin branch renamings in overhangio/tutor-* GitHub settings, which only a repo admin can do.
6. The TPI PR, which adds the next index and switches from @nightly branches to @next branches.
7. The Edly GitLab pipeline updates

No matter how we order these, it seems that there will necessarily be some moments of disruption. Since many of these have to be done by Edly, I can't say what the easiest route forward is, so I leave the decision to you folks. Just let me know what branches my PRs should target and I will do that 😄 Or, feel free to take over those PRs and operate them yourselves if that's easier.

[DawoudSheraz]

As per the latest comments https://discuss.openedx.org/t/tep-rename-nightly-next-and-master-release/12994/9?u=syed_muhammad_dawoud, the new names would be:

• master --> release (default)
• nightly --> main

[DawoudSheraz]

To ensure that both Github and private Gitlab work as expected, the following sequence of events would be taken:

1. Update tutor and plugin yaml files in tutor-ci on Gitlab (as these files are what power the actual build sequences)
2. Rename the branches on Gitlab
3. Rename the branches on Github
4. Merge the PR in release. For tutor core, we would be merging another PR for nightly suffix.
5. Repeat 2-4 for all plugins.

Why should the rename be done before merge?

• If we rename on Gitlab only and then merge on Github, it can cause syncback issues on Github.
• If we merge PRs on Github before rename, the Github actions simply wont run.

Pull Requests

• Tutor Core
  • feat!: Rename branches master->release, nightly->main #1153
  • Change version suffix to 'main' and load plugins from their main branches #1154
• feat!: Rename branches master->release, nightly->main tutor-mfe#239
• feat!: Rename branches master->release, nightly->main tutor-indigo#105
• feat!: Rename branches master->release, nightly->main tutor-discovery#92
• feat!: Rename branches master->release, nightly->main tutor-ecommerce#87
• feat!: Rename branches master->release, nightly->main tutor-credentials#52
• feat!: Rename branches master->release, nightly->main tutor-forum#54
• feat!: Rename branches master->release, nightly->main tutor-notes#44
• feat!: Rename branches master->release, nightly->main tutor-xqueue#36
• feat!: Rename branches master->release, nightly->main tutor-jupyter#17
• feat!: Rename branches master->release, nightly->main tutor-minio#55
• feat!: Rename branches master->release, nightly->main tutor-webui#22
• feat!: Rename branches master->release, nightly->main tutor-android#33
• feat!: Rename branches master->release, nightly->main tutor-cairn#49
• chore: Rename branches master->release, nightly->main cookiecutter-tutor-plugin#38
• (Scorm pending discussion)
• tpi feat!: branch renames nightly -> main tpi#9

We plan to do this tomorrow if all the things are set. If not, we will target this before the end of this week.
cc @kdmccormick @regisb

[regisb]

For the record, GitHub users will have to run the following git commands:

git branch -m master release
git fetch origin
git branch -u origin/release release
git remote set-head origin -a

git branch -m nightly main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a

(That is, assuming that the remote name is "origin")

[regisb]

All done \o/

[DawoudSheraz]

@kdmccormick Thanks for initiating this.

@regisb Thank you for your help in this entire epic, be it the guidance or helping with renaming/merging with your terminal magic 🧙🏽 🪄. You rock, as always. I learned quite a few neat tricks with this work.

I have created an announcement on discuss https://discuss.openedx.org/t/tutor-branches-rename/14455.