From 85a44213b7f819e457d0ddb515816246578ebb94 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9gis=20Behmo?= Date: Sun, 1 May 2022 13:37:43 +0100 Subject: [PATCH] docs: improve changelog to highlight 3rd party contributions With this change, we want to better highlight the contributions of developers to Tutor. We want to publicly acknowledge the positive impact that individuals and companies have on the development of the platform. to that end, each changelog entry can now be suffixed with the name of the author (individual or company) who authored the change. These names will find their way to the release notes for every release. Eventually, we also want to spread these release notes more widely. For instance, we could post new releases to the forum to notify the community of important changes. If you have contributed to Tutor in the past, feel free to open a PR and append your name to the changes that you made. We will not be able to update the release notes for every release out there, but your contributions will be acknowledged from the changelog. --- CHANGELOG-nightly.md | 9 ++++++++- CHANGELOG.md | 34 ++++++++++++++++++++++++---------- 2 files changed, 32 insertions(+), 11 deletions(-) diff --git a/CHANGELOG-nightly.md b/CHANGELOG-nightly.md index 41ccab4..a5553a7 100644 --- a/CHANGELOG-nightly.md +++ b/CHANGELOG-nightly.md @@ -1,3 +1,10 @@ # Changelog (nightly branch) -Note: Breaking changes between versions are indicated by "💥". + diff --git a/CHANGELOG.md b/CHANGELOG.md index 6307343..dafe44b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,27 +1,41 @@ # Changelog -Note: Breaking changes between versions are indicated by "💥". + ## Unreleased - [Fix] Fix broken file upload in studio because of unpinned studio-frontend requirement (see [discussion](https://discuss.overhang.io/t/missing-js-css-files-missing-from-openedx-docker-image-in-studio/2629) and [pull request](https://github.com/openedx/edx-platform/pull/30309)) (thanks @uetuluk!). - [Fix] "The Compose file is invalid" error on mounting dev-only folders. -- [Fix] CMS settings in development. +- [Fix] CMS settings in development. (by @regisb) ## v13.2.0 (2022-04-24) -- [Improvement] Add the `COMPOSE_PROJECT_STARTED` action and run `dev stop` on `local start` (and vice versa). -- [Feature] Introduce `local/dev copyfrom` command to copy contents from a container. +- [Improvement] Add the `COMPOSE_PROJECT_STARTED` action and run `dev stop` on `local start` (and vice versa). (by @regisb) +- [Feature] Introduce `local/dev copyfrom` command to copy contents from a container. (by @regisb) - [Bugfix] Fix a race condition that could prevent a newly provisioned LMS container from starting due to a `FileExistsError` when creating data folders. - [Deprecation] Mark `tutor dev runserver` as deprecated in favor of `tutor dev start`. Since `start` now supports bind-mounting and breakpoint debugging, `runserver` is redundant and will be removed in a future release. - [Improvement] Allow breakpoint debugging when attached to a service via `tutor dev start SERVICE`. -- [Security] Apply rate limiting security fix (see [commit](https://github.com/overhangio/edx-platform/commit/b5723e416e628cac4fa84392ca13e1b72817674f)). -- [Feature] Introduce the ``-m/--mount`` option in ``local`` and ``dev`` commands to auto-magically bind-mount folders from the host. +- [Security] Apply rate limiting security fix (see [commit](https://github.com/overhangio/edx-platform/commit/b5723e416e628cac4fa84392ca13e1b72817674f)). (by @regisb) +- [Feature] Introduce the ``-m/--mount`` option in ``local`` and ``dev`` commands to auto-magically bind-mount folders from the host. (by @regisb) - [Feature] Add `tutor dev quickstart` command, which is similar to `tutor local quickstart`, except that it uses dev containers instead of local production ones and includes some other small differences for the convience of Open edX developers. This should remove some friction from the Open edX development setup process, which previously required that users provision using local producation containers (`tutor local quickstart`) but then stop them and switch to dev containers (`tutor local stop && tutor dev start -d`). -- 💥[Improvement] Make it possible to run `tutor k8s exec ` (#636). As a consequence, it is no longer possible to run quoted commands: `tutor k8s exec ""`. Instead, you should remove the quotes: `tutor k8s exec `. -- 💥[Deprecation] Drop support for the `TUTOR_EDX_PLATFORM_SETTINGS` environment variable. It is now recommended to create a plugin instead. -- 💥[Improvement] Complete overhaul of the plugin extension mechanism. Tutor now has a hook-based Python API: actions can be triggered at different points of the application life cycle and data can be modified thanks to custom filters. The v0 plugin API is still supported, for backward compatibility, but plugin developers are encouraged to migrate their plugins to the new API. See the new plugin tutorial for more information. -- [Improvement] Improved the output of `tutor plugins list`. +- 💥[Improvement] Make it possible to run `tutor k8s exec ` (#636). As a consequence, it is no longer possible to run quoted commands: `tutor k8s exec ""`. Instead, you should remove the quotes: `tutor k8s exec `. (by @regisb) +- 💥[Deprecation] Drop support for the `TUTOR_EDX_PLATFORM_SETTINGS` environment variable. It is now recommended to create a plugin instead. (by @regisb) +- 💥[Improvement] Complete overhaul of the plugin extension mechanism. Tutor now has a hook-based Python API: actions can be triggered at different points of the application life cycle and data can be modified thanks to custom filters. The v0 plugin API is still supported, for backward compatibility, but plugin developers are encouraged to migrate their plugins to the new API. See the new plugin tutorial for more information. (by @regisb) +- [Improvement] Improved the output of `tutor plugins list`. (by @regisb) - [Feature] Add `tutor [dev|local|k8s] status` command, which provides basic information about the platform's status. ## v13.1.11 (2022-04-12)