diff --git a/CHANGELOG.md b/CHANGELOG.md index 4556c4f873..908181f7a6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,22 @@ instructions, because git commits are used to generate release notes: + +## v18.2.0 (2024-12-03) + +- [Bugfix] Do not directly upgrade MySQL from v5.7 to v8.4 when upgrading from quince as MySQL does not allow that. First, upgrade to v8.1 and then to v8.4. This process should be automatic for most users. However, if you are running a third-party MySQL (i.e., `RUN_MYSQL=false`), you are expected to perform this process yourself. Please refer to the third-party provider's documentation for detailed instructions. Ensuring that your MySQL version is up-to-date is crucial for maintaining compatibility and security. (by @Danyal-Faheem) +- [Bugfix] Run MySQL 8.1 as a separate container during upgrade from Olive to Redwood as it crashed otherwise due to the `--mysql-native-password` option not being present. (by @Danyal-Faheem) +- [Improvement] Do not prompt for environment deletion by default on `tutor config save --interactive`. (by @regisb) +- šŸ’„[Improvement] Rename Tutor's two branches (by @kdmccormick): + * Rename **master** to **release**, as this branch runs the latest official Open edX release. + * Rename **nightly** to **main**, as this branch runs the Open edX master (a.k.a. main) branches, which are the basis fort the next Open edX release. + * For Tutor Nightly users who do not set a TUTOR_ROOT, both the project root (`~/.local/share/tutor-nightly` on Linux) and the plugins root (`~/.local/share/tutor-nightly-plugins` on Linux) will be automatically renamed. (by @regisb) +- šŸ’„ [Deprecation] Drop support for python 3.8 and set Python 3.9 as the minimum supported python version. (by @DawoudSheraz) +- [Feature] Add a filter to define the celery workers startup command. (by @Ian2012) +- [Improvement] When building images with `tutorĀ imagesĀ buildĀ --cache-to-registry`, use an OCI-compliant cache artifact format that should be universally compatible with all registries. This enables the use of that option when working with third-party registries such as [Harbor](https://goharbor.io/) or [ECR](https://aws.amazon.com/ecr/). Requires [BuildKitĀ 0.12](https://github.com/moby/buildkit/releases/tag/v0.12.0) or later. (by @angonz and @fghaas) +- [Feature] Add the `TUTOR_BRANCH_IS_MAIN` variable to the template context, which is set to True for users running Tutor Main (by @kdmccormick). +- [Bugfix] Use `TUTOR_BRANCH_IS_MAIN` rather than the edx-platform branch name in order to determine which patches to apply. This way, when developers are testing an edx-platform branch that is not master but which may be *based on* master, they will receive master patches rather than release patches, assuming they are running Tutor Main in the first place (by @kdmccormick). + ## v18.1.4 (2024-10-24) diff --git a/changelog.d/20240726_202449_danyal.faheem_mysql_upgrade_5_7_to_8_4.md b/changelog.d/20240726_202449_danyal.faheem_mysql_upgrade_5_7_to_8_4.md deleted file mode 100644 index 01275c273d..0000000000 --- a/changelog.d/20240726_202449_danyal.faheem_mysql_upgrade_5_7_to_8_4.md +++ /dev/null @@ -1,2 +0,0 @@ -- [Bugfix] Do not directly upgrade MySQL from v5.7 to v8.4 when upgrading from quince as MySQL does not allow that. First, upgrade to v8.1 and then to v8.4. (by @Danyal-Faheem) - This process should be automatic for most users. However, if you are running a third-party MySQL (i.e., RUN_MYSQL=false), you are expected to perform this process yourself. Please refer to the third-party provider's documentation for detailed instructions. Ensuring that your MySQL version is up-to-date is crucial for maintaining compatibility and security. \ No newline at end of file diff --git a/changelog.d/20241018_122745_danyal.faheem_run_mysql_8_1_as_separate_container.md b/changelog.d/20241018_122745_danyal.faheem_run_mysql_8_1_as_separate_container.md deleted file mode 100644 index a4b5403c75..0000000000 --- a/changelog.d/20241018_122745_danyal.faheem_run_mysql_8_1_as_separate_container.md +++ /dev/null @@ -1 +0,0 @@ -- [Bugfix] Run MySQL 8.1 as a separate container during upgrade from Olive to Redwood as it crashed otherwise due to the `--mysql-native-password` option not being present. (by @Danyal-Faheem) \ No newline at end of file diff --git a/changelog.d/20241031_144431_regis_no_delete_env.md b/changelog.d/20241031_144431_regis_no_delete_env.md deleted file mode 100644 index e84aac0782..0000000000 --- a/changelog.d/20241031_144431_regis_no_delete_env.md +++ /dev/null @@ -1 +0,0 @@ -- [Improvement] Do not prompt for environment deletion by default on `tutor config save --interactive`. (by @regisb) diff --git a/changelog.d/20241107_144307_kyle_branch_rename.md b/changelog.d/20241107_144307_kyle_branch_rename.md deleted file mode 100644 index 460e59a905..0000000000 --- a/changelog.d/20241107_144307_kyle_branch_rename.md +++ /dev/null @@ -1,4 +0,0 @@ -- šŸ’„[Improvement] Rename Tutor's two branches (by @kdmccormick): - * Rename **master** to **release**, as this branch runs the latest official Open edX release. - * Rename **nightly** to **main**, as this branch runs the Open edX master (a.k.a. main) branches, which are the basis fort the next Open edX release. - * For Tutor Nightly users who do not set a TUTOR_ROOT, both the project root (`~/.local/share/tutor-nightly` on Linux) and the plugins root (`~/.local/share/tutor-nightly-plugins` on Linux) will be automatically renamed. (by @regisb) diff --git a/changelog.d/20241111_163102_dawoud.sheraz_remove_py38_references.md b/changelog.d/20241111_163102_dawoud.sheraz_remove_py38_references.md deleted file mode 100644 index aeead7e20c..0000000000 --- a/changelog.d/20241111_163102_dawoud.sheraz_remove_py38_references.md +++ /dev/null @@ -1 +0,0 @@ -- šŸ’„ [Deprecation] Drop support for python 3.8 and set Python 3.9 as the minimum supported python version. (by @DawoudSheraz) diff --git a/changelog.d/20241119_100430_crisgarta8_celery_queues.md b/changelog.d/20241119_100430_crisgarta8_celery_queues.md deleted file mode 100644 index d0ec11de84..0000000000 --- a/changelog.d/20241119_100430_crisgarta8_celery_queues.md +++ /dev/null @@ -1 +0,0 @@ -- šŸ’„ [Feature] Add a filter to define the celery workers startup command. (by @Ian2012) diff --git a/changelog.d/20241119_111602_fghaas_image_manifest.md b/changelog.d/20241119_111602_fghaas_image_manifest.md deleted file mode 100644 index 28e6cc901c..0000000000 --- a/changelog.d/20241119_111602_fghaas_image_manifest.md +++ /dev/null @@ -1,8 +0,0 @@ -- [Improvement] When building images with - `tutorĀ imagesĀ buildĀ --cache-to-registry`, use an OCI-compliant cache - artifact format that should be universally compatible with all - registries. This enables the use of that option when working with - third-party registries such as [Harbor](https://goharbor.io/) or - [ECR](https://aws.amazon.com/ecr/). Requires - [BuildKitĀ 0.12](https://github.com/moby/buildkit/releases/tag/v0.12.0) - or later. (by @angonz and @fghaas) diff --git a/changelog.d/20241127_001212_kyle_tutor_branch_is_main.md b/changelog.d/20241127_001212_kyle_tutor_branch_is_main.md deleted file mode 100644 index c804ceee03..0000000000 --- a/changelog.d/20241127_001212_kyle_tutor_branch_is_main.md +++ /dev/null @@ -1,2 +0,0 @@ -- [Feature] Add the `TUTOR_BRANCH_IS_MAIN` variable to the template context, which is set to True for users running Tutor Main (by @kdmccormick). -- [Bugfix] Use `TUTOR_BRANCH_IS_MAIN` rather than the edx-platform branch name in order to determine which patches to apply. This way, when developers are testing an edx-platform branch that is not master but which may be *based on* master, they will receive master patches rather than release patches, assuming they are running Tutor Main in the first place (by @kdmccormick). diff --git a/changelog.d/20241203_212810_danyal.faheem_fix_cms_worker_parameters.md b/changelog.d/20241203_212810_danyal.faheem_fix_cms_worker_parameters.md deleted file mode 100644 index 55466a413c..0000000000 --- a/changelog.d/20241203_212810_danyal.faheem_fix_cms_worker_parameters.md +++ /dev/null @@ -1 +0,0 @@ -- [BugFix] Use the cms-worker parameters for the cms-worker instead of the lms-worker parameters. (by @Danyal-Faheem) \ No newline at end of file diff --git a/tutor/__about__.py b/tutor/__about__.py index 736de996f0..553fb0fe85 100644 --- a/tutor/__about__.py +++ b/tutor/__about__.py @@ -2,7 +2,7 @@ # Increment this version number to trigger a new release. See # docs/tutor.html#versioning for information on the versioning scheme. -__version__ = "18.1.4" +__version__ = "18.2.0" # The version suffix will be appended to the actual version, separated by a # dash. Use this suffix to differentiate between the actual released version and