diff --git a/CHANGELOG.md b/CHANGELOG.md index f0146dfdec..11011201c2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,22 @@ instructions, because git commits are used to generate release notes: + +## v17.0.2 (2024-02-09) + +- [Feature] Several enhancements to the Demo Course (by @kdmccormick): + - The [Open edX Demo Course](https://github.com/openedx/openedx-demo-course) has been re-built from scratch with up-to-date instruction-focused content. Its directory structure has changed. + - In order to support both the old and new structures of the Demo Course's repository, the command `tutor local do importdemocourse` will now auto-determine the course root based on the location of `course.xml`. Use the `--repo-dir` argument to override this behavior. + - The new command `tutor local do importdemolibraries` will import any content libraries defined within the Demo Course repository. At the moment, that is just the "Respiratory System Question Bank", which is an optional but helpful extension to the new Demo Course. + - To try out the new Demo Course now, run: `tutor local do importdemocourse --version master`. + - To try out the demo Respiratory System Question Bank now, run: `tutor local do importdemolibraries --version master`. + - To revert back to an older Demo Course version at any point, run: `tutor local do importdemocourse --version open-release/quince.2`, replacing `quince.2` with your preferred course version. +- [Bugfix] Remove duplicate volume declarations that cause `docker compose` v2.24.1 to fail. +- [Bugfix] Actually update the environment on `tutor plugins enable ...`. (by @regisb) +- [Feature] Introduce a `tutor.hooks.lru_cache` decorator that is automatically cleared whenever a plugin is loaded or unloaded. This is useful, in particular when a plugin implements a costly function that depends on tutor hooks. (by @regisb) +- [Bugfix] Fix compatibility with Python 3.12 by replacing pkg_resources with importlib_metadata and importlib_resources. (by @Danyal-Faheem) +- [Improvement] Upgrade base release to open-release/quince.2. (by @regisb) + ## v17.0.1 (2024-01-25) diff --git a/changelog.d/20240110_101228_kyle_importnewdemocourse.md b/changelog.d/20240110_101228_kyle_importnewdemocourse.md deleted file mode 100644 index 79a7d44b70..0000000000 --- a/changelog.d/20240110_101228_kyle_importnewdemocourse.md +++ /dev/null @@ -1,7 +0,0 @@ -- [Feature] Several enhancements to the Demo Course (by @kdmccormick): - - The [Open edX Demo Course](https://github.com/openedx/openedx-demo-course) has been re-built from scratch with up-to-date instruction-focused content. Its directory structure has changed. - - In order to support both the old and new structures of the Demo Course's repository, the command `tutor local do importdemocourse` will now auto-determine the course root based on the location of `course.xml`. Use the `--repo-dir` argument to override this behavior. - - The new command `tutor local do importdemolibraries` will import any content libraries defined within the Demo Course repository. At the moment, that is just the "Respiratory System Question Bank", which is an optional but helpful extension to the new Demo Course. - - To try out the new Demo Course now, run: `tutor local do importdemocourse --version master`. - - To try out the demo Respiratory System Question Bank now, run: `tutor local do importdemolibraries --version master`. - - To revert back to an older Demo Course version at any point, run: `tutor local do importdemocourse --version open-release/quince.2`, replacing `quince.2` with your preferred course version. diff --git a/changelog.d/20240129_144929_kshitij_fix_tutor_docker_compose.md b/changelog.d/20240129_144929_kshitij_fix_tutor_docker_compose.md deleted file mode 100644 index 4a9625ced2..0000000000 --- a/changelog.d/20240129_144929_kshitij_fix_tutor_docker_compose.md +++ /dev/null @@ -1,2 +0,0 @@ -- [Bugfix] Fixes duplicate volume declarations causing Tutor commands that - invoke Docker to fail. \ No newline at end of file diff --git a/changelog.d/20240130_123351_regis_fix_save_on_plugins.md b/changelog.d/20240130_123351_regis_fix_save_on_plugins.md deleted file mode 100644 index 164dd818c3..0000000000 --- a/changelog.d/20240130_123351_regis_fix_save_on_plugins.md +++ /dev/null @@ -1,2 +0,0 @@ -- [Bugfix] Actually update the environment on `tutor plugins enable ...`. (by @regisb) -- [Feature] Introduce a `tutor.hooks.lru_cache` decorator that is automatically cleared whenever a plugin is loaded or unloaded. This is useful, in particular when a plugin implements a costly function that depends on tutor hooks. (by @regisb) diff --git a/changelog.d/20240202_153925_danyal.faheem_remove_pkg_resources.md b/changelog.d/20240202_153925_danyal.faheem_remove_pkg_resources.md deleted file mode 100644 index d7cd4d9b8a..0000000000 --- a/changelog.d/20240202_153925_danyal.faheem_remove_pkg_resources.md +++ /dev/null @@ -1 +0,0 @@ -[Depreciation] Replace pkg_resources with importlib_metadata and importlib_resources. (by @Danyal-Faheem) \ No newline at end of file diff --git a/changelog.d/20240209_220759_regis.md b/changelog.d/20240209_220759_regis.md deleted file mode 100644 index bb40ed3119..0000000000 --- a/changelog.d/20240209_220759_regis.md +++ /dev/null @@ -1 +0,0 @@ -- [Improvement] Upgrade base release to open-release/quince.2. (by @regisb) diff --git a/tutor/__about__.py b/tutor/__about__.py index 3b0f631190..c49850aaad 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__ = "17.0.1" +__version__ = "17.0.2" # 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