christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-17 02:25:10 +00:00
Code Issues Releases Activity
1890557d40
tutor/CHANGELOG-nightly.md

27 lines
2.9 KiB
Markdown
Raw Normal View History

docs: nightly development workflow
2021-09-28 16:38:22 +00:00
# Changelog (nightly branch)
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.
2022-05-01 12:37:43 +00:00
<!--
Merge branch 'master' into nightly
2022-05-06 14:14:26 +00:00
This changelog is for tracking changes made to the nightly branch (see:
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.
2022-05-01 12:37:43 +00:00
https://docs.tutor.overhang.io/tutorials/nightly.html). The format of this file is identical
Merge branch 'master' into nightly
2022-05-06 14:14:26 +00:00
to the CHANGELOG.md file, except that there are no release or "Unrelased" sections. Entries
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.
2022-05-01 12:37:43 +00:00
will be backported to the master branch at every major release.
When backporting changes to master, we should keep only the entries that correspond to user-
facing changes.
-->
feat: add `-h` help option to all commands
2022-11-11 13:13:36 +00:00
- [Improvement] Add the `-h` help option to all commands and subcommands. Previously, we could only use `--help`, which is quite long for lazy fingers. (by @regisb)
feat: pluggable `local/dev/k8s do <job>` commands We introduce a new filter to implement custom commands in arbitrary containers. It becomes easy to write convenient ad-hoc commands that users will then be able to run either on Kubernetes or locally using a documented CLI. Pluggable jobs are declared as Click commands and are responsible for parsing their own arguments. See the new CLI_DO_COMMANDS filter. Close https://github.com/overhangio/2u-tutor-adoption/issues/75
2022-10-19 15:46:31 +00:00
- 💥[Feature] Add an extensible `local/dev/k8s do ...` command to trigger custom job commands. These commands are used to run a series of bash scripts in designated containers. Any plugin can add custom jobs thanks to the `CLI_DO_COMMANDS` filter. This causes the following breaking changes:
- The "init", "createuser", "settheme", "importdemocourse" commands were all migrated to this new interface. For instance, `tutor local init` was replaced by `tutor local do init`.
- Plugin developers are encouraged to replace calls to the `COMMANDS_INIT` and `COMMANDS_PRE_INIT` filters by `CLI_DO_INIT_TASKS`.
feat: filter priorities Nothing revolutionary here, we just implement the same priority queue that existed in actions. It will be necessary to trigger init tasks in the right order.
2022-11-08 15:09:16 +00:00
- [Feature] Implement hook filter priorities, which work like action priorities. (by @regisb)
depr: get rid of the `local/dev bindmount` commands This command has always been clunky. It is now removed in favour of the `-m/--mount` option. Close https://github.com/overhangio/2u-tutor-adoption/issues/88 Close https://github.com/overhangio/2u-tutor-adoption/issues/89
2022-10-18 12:40:32 +00:00
- 💥[Improvement] Remove the `local/dev bindmount` commands, which have been marked as deprecated for some time. The `--mount` option should be used instead.
fix: installation of local requirements The `compilejsi18n` command was failing during image building because the Open-edX package was not installed properly. The reason for that was an earlier change where we got rid of the `pip install -r requirements/edx/local.in` command. Installing the Open-edX package was part of this requirement file. The local.in requirements file no longer exists, but we still need to `pip install -e .` the edx-platform repo. To run this command we need both the edx-platform repo and the virtualenv. The good news is that there are no more local requirements in the base.txt requirements file. This means that we no longer have to COPY the edx-platform repo in the requirements installation step. Thus, changes in edx-platform will no longer trigger a rebuild of the pip requirements; this means that re-builds will be much faster when making changes to edx-platform. Note that plugins that implemented the "openedx-dockerfile-post-python-requirements" patch and that needed access to the edx-platform repo will no longer work. Instead, these plugins should implement the "openedx-dockerfile-pre-assets" patch. This scenario should be very rare, though. Close #726
2022-10-03 10:00:11 +00:00
- 💥[Bugfix] Fix local installation requirements. Plugins that implemented the "openedx-dockerfile-post-python-requirements" patch and that needed access to the edx-platform repo will no longer work. Instead, these plugins should implement the "openedx-dockerfile-pre-assets" patch. This scenario should be very rare, though. (by @regisb)
feat: deprecate "quickstart" and rename to "launch" `quickstart` is being renamed to `launch` and deprecated in favor of using `launch`. The `quickstart` function temporarily aliases to `launch`. Further mentions of `quickstart` have been changed to reference `launch` instead. We are indicating that this change is breaking 💥 to encourage people to migrate their scripts right away!
2022-09-30 10:00:24 +00:00
- 💥[Improvement] Rename the implementation of tutor <mode> quickstart to tutor <mode> launch. (by @Carlos-Muniz)
docs: add entry to CHANGELOG-nightly.md
2022-07-21 19:51:42 +00:00
- 💥[Improvement] Remove the implementation of tutor dev runserver. (by @Carlos-Muniz)
fix: replica set error from pymongo 3.10 -> 3.12 upgrade The pymongo dependency for edx-platform was updated (3.10.1 to 3.12.3) in https://github.com/openedx/edx-platform/pull/30569 This caused the following error when running the edx-platform database migration split_modulestore_django.0002_data_migration as part of `tutor dev quickstart`: pymongo.errors.ServerSelectionTimeoutError: client is configured to connect to a replica set named '' but this node belongs to a set named 'None', Timeout: 30s, Topology Description: <TopologyDescription id: 62bdbaf182687350acf1aeec, topology_type: Single, servers: [<ServerDescription ('mongodb', 27017) server_type: Unknown, rtt: None, error=ConfigurationError("client is configured to connect to a replica set named '' but this node belongs to a set named 'None'")>]> This commit explicitly sets replicaSet to None to indicate that it's a standalone MongoDB instance. I also had to remove the CONTENTSTORE entry from auth.yml because edx-platform's devstack.py assumes it has a non-null value (set in common.py), and devstack.py executes before tutor's development.py can set this replicaSet value.
2022-06-30 15:23:01 +00:00
- [Bugfix] Fix MongoDB replica set connection error resulting from edx-platform's pymongo (3.10.1 -> 3.12.3) upgrade ([edx-platform#30569](https://github.com/openedx/edx-platform/pull/30569)). (by @ormsbee)
build: NIGHTLY ONLY: install nightly branches of official plugins For Tutor Nightly (and only Nightly), official plugins are now installed from their nightly branches on GitHub instead of a version range on PyPI. This will allow Nightly users to install all official plugins by running: pip install -e ".[full]" Notes: * We use the syntax `EGG @ git+REPO@nightly` because the more common syntax of `git+REPO@nightly#egg=EGG` does not work when supplied to setup.py's extras_require. * Unlike other plugins, tutor-license is still installed from PyPI, but without any version constraint. This is because tutor-license is a simple, closed-source plugin which activates Wizard edition for subscribers. It should be available in Nightly but doesn't need to be installed from its own bleeding-edge branch. * Unlike most nightly commits, this commit should NOT ever be reflected on master. When it comes time to merge nightly into master during the release of Nutmeg, this commit will need to be manually reverted from master. * Documentation updates have been made separately so that they can be merged into master.
2022-04-06 14:29:09 +00:00
- [Improvement] For Tutor Nightly (and only Nightly), official plugins are now installed from their nightly branches on GitHub instead of a version range on PyPI. This will allow Nightly users to install all official plugins by running ``pip install -e ".[full]"``.
fix: remove references to edX from bulk emails Bulk course emails used to contain many references to edX. This is resolved here by switching to edx-ace for sending emails. See: https://github.com/openedx/build-test-release-wg/issues/100 https://edx.readthedocs.io/projects/edx-platform-technical/en/latest/featuretoggles.html#featuretoggle-BULK_EMAIL_SEND_USING_EDX_ACE https://github.com/openedx/edx-platform/pull/29900
2022-03-28 08:54:03 +00:00
- [Bugfix] Remove edX references from bulk emails ([issue](https://github.com/openedx/build-test-release-wg/issues/100)).
fix: lms-worker/cms-worker command update for Celery 5 Before edx-platform was upgraded to Celery 5, lms-worker and cms-worker could be invoked using this syntax: celery worker --app=APP <args> --maxtasksperchild=N <args> Since the recent Celery 5 upgrade (edx-platform commit 0588c92), though, this fails with the messages: You are using `--app` as an option of the worker sub-command: celery worker --app celeryapp <...> The support for this usage was removed in Celery 5.0. Instead you should use `--app` as a global option: celery --app celeryapp worker <...> and: Error: No such option: --maxtasksperchild (Possible options: --max-memory-per-child, --max-tasks-per-child) So, this commit changes the lms-worker and cms-worker invocations to: celery --app=APP <args> --max-tasks-per-child=N <args>
2022-03-18 14:17:20 +00:00
- [Bugfix] Update ``celery`` invocations for lms-worker and cms-worker to be compatible with Celery 5 CLI.
chore: set CMS_CFG instead of STUDIO_CFG In the LMS/CMS Dockerfile, the env var STUDIO_CFG is set in order to point CMS at its configuration json/yaml file. Since https://github.com/edx/edx-platform/pull/29534 (which introduced 0013-cms-vs-studio.rst), the STUDIO_CFG variable has been deprecated in favor of CMS_CFG. This change updates the Dockerfile to reflect the new preferred environment variable. The only noticeable impact of this change is that it will remove a depreation warning from Django startup for tutor uses running off of Open edX master.
2022-01-11 15:40:18 +00:00
- [Improvement] Point CMS at its config file using ``CMS_CFG`` environment variable instead of deprecated ``STUDIO_CFG``.
fix: a migration on nightly/master open edx now requires MongoDB
2021-12-15 19:33:48 +00:00
- [Bugfix] Start MongoDB when running migrations, because a new data migration fails if MongoDB is not running
Merge branch 'master' into nightly
2022-05-06 14:14:26 +00:00
Copy Permalink