Skip to content

Commit

Permalink
perf: sumac release support AP-1582 (#74)
Browse files Browse the repository at this point in the history
  • Loading branch information
BryanttV authored Nov 28, 2024
1 parent ecc2afe commit 33bc6af
Show file tree
Hide file tree
Showing 10 changed files with 38 additions and 29 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/integration-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
tutor_version: ['<18.0.0', '<19.0.0', 'nightly']
tutor_version: ['<19.0.0', '<20.0.0', 'nightly']
steps:
- name: Run Integration Tests
uses: eduNEXT/integration-test-in-tutor@main
Expand Down
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [v8.1.0](https://github.com/eduNEXT/eox-theming/compare/v8.0.0...v8.1.0) - (2024-11-27)

### Changed

- **Sumac Support**: Upgrade requirements base on edx-platform Sumac
release and update integration tests to use new Sumac release with Tutor.

## v8.0.0 - 2024-10-22

## [v8.0.0](https://github.com/eduNEXT/eox-theming/compare/v7.2.0...v8.0.0) - (2024-10-22)
Expand Down
20 changes: 11 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,12 @@ Compatibility Notes
+------------------+---------------+
| Redwood | >= 7.2.0 |
+------------------+---------------+
| Sumac | >= 8.1.0 |
+------------------+---------------+

⚠️ From Lilac version Django 2.2 is not supported, you should use Django 3.2 and eox-tenant >=4.0.

The plugin is configured for the latest release (Redwood). If you need compatibility for previous releases, go to the README of the relevant version tag and if it is necessary you can change the configuration in ``eox_theming/settings/common.py``.
The plugin is configured for the latest release (Sumac). If you need compatibility for previous releases, go to the README of the relevant version tag and if it is necessary you can change the configuration in ``eox_theming/settings/common.py``.

For example, if you need compatibility for Koa, you can go to the `v2.0.0 README <https://github.com/eduNEXT/eox-theming/blob/v2.0.0/README.md>`_ to the ``Compatibility Notes`` section; you'll see something like this:

Expand Down Expand Up @@ -75,9 +77,9 @@ Installation
============

#. Install the plugin adding it to ``OPENEDX_EXTRA_PIP_REQUIREMENTS`` in the ``config.yml``.

.. code-block:: yaml
OPENEDX_EXTRA_PIP_REQUIREMENTS:
- eox-theming=={{version}}
Expand All @@ -92,7 +94,7 @@ If you chose to use ``Distro Tutor Plugin``, just follow the instructions given
#. Add the themes to your instance by adding your themes folder to the container shared folder ``env/build/openedx/themes``

#. Compile the themes after adding them:

.. code-block:: bash
tutor images build openedx
Expand All @@ -105,15 +107,15 @@ If you chose to use ``Distro Tutor Plugin``, just follow the instructions given
#. Add the following settings to your environment file ``env/apps/openedx/settings/lms/production.py``:

.. code:: python
COMPREHENSIVE_THEME_DIRS.extend(
[
"/path-to-your-themes-folder/in-the-lms-container/edx-platform",
"/path-to-your-themes-folder/in-the-lms-container/edx-platform/sub-folder-with-more-themes",
]
)
EOX_THEMING_DEFAULT_THEME_NAME = "my-theme-1" # Or the theme you want
################## EOX_THEMING ##################
if "EOX_THEMING_DEFAULT_THEME_NAME" in locals() and EOX_THEMING_DEFAULT_THEME_NAME:
from lms.envs.common import _make_mako_template_dirs # pylint: disable=import-error
Expand Down Expand Up @@ -145,7 +147,7 @@ Use case example
================

Having the following theme folder structure:

.. code-block:: txt
themes-main-folder
Expand Down Expand Up @@ -185,7 +187,7 @@ You can see there are 3 levels of customization in the themes folder: ``global-c
#. Then, ensure are properly configured the `Settings`_ required and customize these:

.. code:: python
COMPREHENSIVE_THEME_DIRS.extend(
[
"/openedx/themes/themes-main-folder/edx-platform",
Expand Down Expand Up @@ -222,4 +224,4 @@ quality, which will make your contribution more likely to be accepted.
License
=======

This project is licensed under the AGPL-3.0 License. See the `LICENSE <LICENSE.txt>`_ file for details.
This project is licensed under the AGPL-3.0 License. See the `LICENSE <LICENSE.txt>`_ file for details.
2 changes: 1 addition & 1 deletion eox_theming/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

from __future__ import unicode_literals

__version__ = '8.0.0'
__version__ = '8.1.0'
4 changes: 2 additions & 2 deletions requirements/base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ django==4.2.16
# via
# -c https://raw.githubusercontent.com/openedx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/base.in
eox-tenant==11.7.0
eox-tenant==12.1.0
# via -r requirements/base.in
six==1.16.0
# via -r requirements/base.in
sqlparse==0.5.1
sqlparse==0.5.2
# via django
typing-extensions==4.12.2
# via asgiref
2 changes: 1 addition & 1 deletion requirements/django42.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Django==4.2.8
django==4.2.16
6 changes: 3 additions & 3 deletions requirements/pip-tools.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ click==8.1.7
# via pip-tools
importlib-metadata==8.5.0
# via build
packaging==24.1
packaging==24.2
# via build
pip-tools==7.4.1
# via -r requirements/pip-tools.in
pyproject-hooks==1.2.0
# via
# build
# pip-tools
tomli==2.0.2
tomli==2.1.0
# via
# build
# pip-tools
wheel==0.44.0
wheel==0.45.1
# via pip-tools
zipp==3.20.2
# via importlib-metadata
Expand Down
8 changes: 4 additions & 4 deletions requirements/test.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ dill==0.3.9
# djangorestframework
djangorestframework==3.15.2
# via -r requirements/test.in
eox-tenant==11.7.0
eox-tenant==12.1.0
# via -r requirements/base.txt
exceptiongroup==1.2.2
# via pytest
Expand All @@ -51,7 +51,7 @@ mccabe==0.7.0
# via pylint
mock==5.1.0
# via -r requirements/test.in
packaging==24.1
packaging==24.2
# via pytest
path==17.0.0
# via path-py
Expand All @@ -77,13 +77,13 @@ requests==2.32.3
# via -r requirements/test.in
six==1.16.0
# via -r requirements/base.txt
sqlparse==0.5.1
sqlparse==0.5.2
# via
# -r requirements/base.txt
# django
testfixtures==8.3.0
# via -r requirements/test.in
tomli==2.0.2
tomli==2.1.0
# via
# pylint
# pytest
Expand Down
8 changes: 4 additions & 4 deletions requirements/tox.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ filelock==3.16.1
# via
# tox
# virtualenv
packaging==24.1
packaging==24.2
# via
# pyproject-api
# tox
Expand All @@ -28,13 +28,13 @@ pluggy==1.5.0
# via tox
pyproject-api==1.8.0
# via tox
tomli==2.0.2
tomli==2.1.0
# via
# pyproject-api
# tox
tox==4.23.1
tox==4.23.2
# via -r requirements/tox.in
typing-extensions==4.12.2
# via tox
virtualenv==20.27.0
virtualenv==20.28.0
# via tox
8 changes: 4 additions & 4 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 8.0.0
current_version = 8.1.0
commit = False
tag = False

Expand All @@ -19,7 +19,7 @@ line_length = 120
multi_line_output = 3

[pylint.messages_control]
enable =
enable =
line-too-long,
syntax-error,
init-is-generator,
Expand Down Expand Up @@ -190,7 +190,7 @@ enable =
useless-suppression,
bad-inline-option,
deprecated-pragma,
disable =
disable =
invalid-name,
file-ignored,
bad-indentation,
Expand All @@ -216,7 +216,7 @@ disable =

[coverage:run]
data_file = .coverage
omit =
omit =
venv/*
eox_theming/edxapp_wrapper/backends/*

Expand Down

0 comments on commit 33bc6af

Please sign in to comment.