feat: upgrade to Quince

overhangio · Dec 11, 2023 · 0d01282 · 0d01282
1 parent 0751918
commit 0d01282
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 14 deletions.
diff --git 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
@@ -19,3 +19,12 @@ instructions, because git commits are used to generate release notes:
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-17.0.0'></a>
+## 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
@@ -1,9 +1,9 @@
 Students notes plugin for `Tutor <https://docs.tutor.edly.io>`_
 ===================================================================
 
-This is a plugin for `Tutor <https://docs.tutor.edly.io>`_ to easily add the `Open edX note-taking app <https://github.com/openedx/edx-notes-api>`_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation <https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-palm.master/exercises_tools/notes.html>`_).
+This is a plugin for `Tutor <https://docs.tutor.edly.io>`_ to easily add the `Open edX note-taking app <https://github.com/openedx/edx-notes-api>`_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation <https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-quince.master/exercises_tools/notes.html>`_).
 
-.. 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
diff --git a/changelog.d/20230731_075900_jhony.avella_remove_permissions_container.md b/changelog.d/20230731_075900_jhony.avella_remove_permissions_container.md
diff --git a/changelog.d/20231005_153517_codewithemad.md b/changelog.d/20231005_153517_codewithemad.md
diff --git 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
@@ -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
@@ -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