diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 9b4f56e..c140c62 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -2,7 +2,7 @@ variables: TUTOR_PLUGIN: notes TUTOR_IMAGES: notes TUTOR_PYPI_PACKAGE: tutor-notes - OPENEDX_RELEASE: palm + OPENEDX_RELEASE: quince GITHUB_REPO: overhangio/tutor-notes include: diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d5d920..9a2fe25 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,3 +19,12 @@ instructions, because git commits are used to generate release notes: + +## v17.0.0 (2023-12-09) + +- 💥 [Feature] Upgrade to Quince. +- [Improvement] Add a scriv-compliant changelog. (by @regisb) +- [Improvement] Removing the notes permissions container in favor of a global single permissions container. (by @jfavellar90) +- [Improvement] Added Makefile and test action to repository and formatted code with Black and isort. (by @CodeWithEmad) + + diff --git a/README.rst b/README.rst index 1fc2dfe..c9538e6 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,9 @@ Students notes plugin for `Tutor `_ =================================================================== -This is a plugin for `Tutor `_ to easily add the `Open edX note-taking app `_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation `_). +This is a plugin for `Tutor `_ to easily add the `Open edX note-taking app `_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation `_). -.. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-palm.master/_images/SFD_SN_bodyexample.png +.. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-quince.master/_images/SFD_SN_bodyexample.png :alt: Notes in action Installation diff --git a/changelog.d/20230519_161836_regis.md b/changelog.d/20230519_161836_regis.md deleted file mode 100644 index 7d796ae..0000000 --- a/changelog.d/20230519_161836_regis.md +++ /dev/null @@ -1 +0,0 @@ -- [Improvement] Add a scriv-compliant changelog. (by @regisb) diff --git a/changelog.d/20230731_075900_jhony.avella_remove_permissions_container.md b/changelog.d/20230731_075900_jhony.avella_remove_permissions_container.md deleted file mode 100644 index 99a9008..0000000 --- a/changelog.d/20230731_075900_jhony.avella_remove_permissions_container.md +++ /dev/null @@ -1 +0,0 @@ -- [Improvement] Removing the notes permissions container in favor of a global single permissions container. (by @jfavellar90) diff --git a/changelog.d/20231005_153517_codewithemad.md b/changelog.d/20231005_153517_codewithemad.md deleted file mode 100644 index 81ca4f1..0000000 --- a/changelog.d/20231005_153517_codewithemad.md +++ /dev/null @@ -1 +0,0 @@ -- [Improvement] Added Makefile and test action to repository and formatted code with Black and isort. (by @CodeWithEmad) \ No newline at end of file diff --git a/setup.py b/setup.py index 53a1448..91aa9e8 100644 --- a/setup.py +++ b/setup.py @@ -32,8 +32,8 @@ packages=find_packages(exclude=["tests*"]), include_package_data=True, python_requires=">=3.8", - install_requires=["tutor>=16.0.0,<17.0.0"], - extras_require={"dev": ["tutor[dev]>=16.0.0,<17.0.0"]}, + install_requires=["tutor>=17.0.0,<18.0.0"], + extras_require={"dev": ["tutor[dev]>=17.0.0,<18.0.0"]}, entry_points={"tutor.plugin.v1": ["notes = tutornotes.plugin"]}, classifiers=[ "Development Status :: 5 - Production/Stable", diff --git a/tutornotes/__about__.py b/tutornotes/__about__.py index eabf3d3..a08b09c 100644 --- a/tutornotes/__about__.py +++ b/tutornotes/__about__.py @@ -1 +1 @@ -__version__ = "16.0.2" +__version__ = "17.0.0" diff --git a/tutornotes/templates/notes/build/notes/Dockerfile b/tutornotes/templates/notes/build/notes/Dockerfile index 68c95f9..d977fc3 100644 --- a/tutornotes/templates/notes/build/notes/Dockerfile +++ b/tutornotes/templates/notes/build/notes/Dockerfile @@ -1,9 +1,9 @@ -{% if is_buildkit_enabled() %}# syntax=docker/dockerfile:1.4{% endif %} +# syntax=docker/dockerfile:1.4 FROM docker.io/ubuntu:20.04 ENV DEBIAN_FRONTEND=noninteractive -RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/var/cache/apt,sharing=locked \ - --mount=type=cache,target=/var/lib/apt,sharing=locked{% endif %} \ +RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \ + --mount=type=cache,target=/var/lib/apt,sharing=locked \ apt update && \ apt upgrade -y && \ apt install -y \ @@ -30,8 +30,8 @@ ENV PATH /app/venv/bin:${PATH} # https://pypi.org/project/setuptools/ # https://pypi.org/project/pip/ # https://pypi.org/project/wheel/ -RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/app/.cache/pip,sharing=shared {% endif %}pip install setuptools==67.8.0 pip==23.1.2 wheel==0.40.0 -RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/app/.cache/pip,sharing=shared {% endif %}pip install -r requirements/base.txt +RUN --mount=type=cache,target=/app/.cache/pip,sharing=shared pip install setuptools==68.2.2 pip==23.2.1 wheel==0.41.2 +RUN --mount=type=cache,target=/app/.cache/pip,sharing=shared pip install -r requirements/base.txt EXPOSE 8000 CMD gunicorn --workers=2 --name notes --bind=0.0.0.0:8000 --max-requests=1000 notesserver.wsgi:application