From 1d57879cc86b0d8d860fae050dbc3c2973a39ba8 Mon Sep 17 00:00:00 2001
From: Syed Muhammad Dawoud Sheraz Ali <dawoud.sheraz@gmail.com>
Date: Tue, 19 Nov 2024 12:35:13 +0500
Subject: [PATCH] feat!: Rename branches master->release, nightly->main

---
 .github/workflows/sync.yml                                 | 2 +-
 .github/workflows/test.yml                                 | 4 +++-
 README.rst                                                 | 2 +-
 changelog.d/20241119_123431_dawoud.sheraz_branch_rename.md | 3 +++
 tutordiscovery/plugin.py                                   | 2 +-
 5 files changed, 9 insertions(+), 4 deletions(-)
 create mode 100644 changelog.d/20241119_123431_dawoud.sheraz_branch_rename.md

diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml
index 3f22fa5..b368a67 100644
--- a/.github/workflows/sync.yml
+++ b/.github/workflows/sync.yml
@@ -2,7 +2,7 @@ name: Sync with private repo
 
 on:
   push:
-    branches: [ master, main, nightly ]
+    branches: [ release, main ]
 
 jobs:
   sync:
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 23a429f..d887c00 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -2,7 +2,9 @@ name: Run tests
 
 on:
   pull_request:
-    branches: [master]
+    branches: [release, main]
+  push:
+    branches: [release, main]
 
 jobs:
   tests:
diff --git a/README.rst b/README.rst
index a904db5..3623b64 100644
--- a/README.rst
+++ b/README.rst
@@ -218,4 +218,4 @@ License
 
 This work is licensed under the terms of the `GNU Affero General Public License (AGPL)`_.
 
-.. _GNU Affero General Public License (AGPL): https://github.com/overhangio/tutor/blob/master/LICENSE.txt
+.. _GNU Affero General Public License (AGPL): https://github.com/overhangio/tutor/blob/release/LICENSE.txt
diff --git a/changelog.d/20241119_123431_dawoud.sheraz_branch_rename.md b/changelog.d/20241119_123431_dawoud.sheraz_branch_rename.md
new file mode 100644
index 0000000..fb6e264
--- /dev/null
+++ b/changelog.d/20241119_123431_dawoud.sheraz_branch_rename.md
@@ -0,0 +1,3 @@
+- 💥[Improvement] Rename Tutor's two branches (by @DawoudSheraz):
+  * Rename **master** to **release**, as this branch runs the latest official Open edX release tag.
+  * Rename **nightly** to **main**, as this branch runs the Open edX master branches, which are the basis for the next Open edX release.
\ No newline at end of file
diff --git a/tutordiscovery/plugin.py b/tutordiscovery/plugin.py
index 5fcdc22..6633d5d 100644
--- a/tutordiscovery/plugin.py
+++ b/tutordiscovery/plugin.py
@@ -10,7 +10,7 @@
 
 from .__about__ import __version__
 
-# Handle version suffix in nightly mode, just like tutor core
+# Handle version suffix in main mode, just like tutor core
 if __version_suffix__:
     __version__ += "-" + __version_suffix__