🔖(chore) bump to 3.1.1

Fixed

- Prevent indexation failure when a thumbnail generation fails

Author: kernicPanel

CHANGELOG.md

@@ -8,6 +8,8 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unrealeased]
 
+## [3.1.1] - 2025-05-21
+
 ### Fixed
 
 - Prevent indexation failure when a thumbnail generation fails
@@ -2301,7 +2303,8 @@ us:
 - finish integrating the missing pages and improve the sandbox environment;
 - test and polish the use of richie as a django app / node dependency.
 
-[unreleased]: https://github.com/openfun/richie/compare/v3.1.0...master
+[unreleased]: https://github.com/openfun/richie/compare/v3.1.1...master
+[3.1.1]: https://github.com/openfun/richie/compare/v3.1.0...v3.1.1
 [3.1.0]: https://github.com/openfun/richie/compare/v3.0.0...v3.1.0
 [3.0.0]: https://github.com/openfun/richie/compare/v3.0.0-beta.0...v3.0.0
 [3.0.0-beta.0]: https://github.com/openfun/richie/compare/v2.34.0...v3.0.0-beta.0

cookiecutter/{{cookiecutter.organization}}-richie-site-factory/template/{{cookiecutter.site}}/requirements/base.txt

@@ -5,6 +5,6 @@ django-storages==1.13.2
 dockerflow==2022.8.0
 gunicorn==23.0.0
 psycopg2-binary==2.9.9
-richie==3.1.0
+richie==3.1.1
 unidecode==1.3.6 # required by django-check-seo
 sentry-sdk==2.11.0

cookiecutter/{{cookiecutter.organization}}-richie-site-factory/template/{{cookiecutter.site}}/src/frontend/package.json

@@ -21,7 +21,7 @@
     "CMS"
   ],
   "dependencies": {
-    "richie-education": "3.1.0"
+    "richie-education": "3.1.1"
   },
   "devDependencies": {
     "@formatjs/cli": "6.3.11",

docs/cookiecutter.md

@@ -25,15 +25,15 @@ If you chose to install Cookiecutter, you can now run it against our
 [template][2] as follows:
 
 ```bash
-cookiecutter gh:openfun/richie --directory cookiecutter  --checkout v3.1.0
+cookiecutter gh:openfun/richie --directory cookiecutter  --checkout v3.1.1
 ```
 
 If you didn't want to install it on your machine, we provide a Docker image
 built with our [own repository][4] that you can use as follows:
 
 ```bash
 docker run --rm -it -u $(id -u):$(id -g) -v $PWD:/app \
-fundocker/cookiecutter gh:openfun/richie --directory cookiecutter --checkout v3.1.0
+fundocker/cookiecutter gh:openfun/richie --directory cookiecutter --checkout v3.1.1
 ```
 
 The `--directory` option is to indicate that our Cookiecutter template is in

src/frontend/package.json

@@ -1,6 +1,6 @@
 {
   "name": "richie-education",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "A CMS to build learning portals for Open Education",
   "main": "sandbox/manage.py",
   "scripts": {

tests_e2e/package.json

@@ -1,6 +1,6 @@
 {
   "name": "richie-tests-e2e",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "End-to-end tests for the Richie project",
   "repository": "https://github.com/openfun/richie",
   "author": "Open FUN (France Université Numérique)",

website/package.json

@@ -1,6 +1,6 @@
 {
   "name": "richie-education-docs",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "Documentation website for the Richie project",
   "scripts": {
     "build": "docusaurus build",

website/versioned_docs/version-3.1.1/accessibility-testing.md

@@ -0,0 +1,46 @@
+---
+id: accessibility-testing
+title: Automated accessibility checks
+sidebar_label: Accessibility testing
+---
+
+Richie includes automated accessibility checks built through a `Cypress` end-to-end testing infrastructure.
+
+Automated accessibility checks can only surface around 30% of possible problems on any given page. This does not mean they are not useful, but they cannot replace human audits and developer proficiency.
+
+We use `axe` to run these checks. You can find more about axe on the [`axe-core` GitHub repository](https://github.com/dequelabs/axe-core).
+
+## Testing environment setup
+
+Both `Cypress` and `axe` are used through their respective NPM packages. This means everything goes through `yarn` commands. You need to have `node` and `yarn` installed locally to run the tests.
+
+```bash
+cd tests_e2e
+yarn install
+```
+
+This should install everything you need.
+
+## Running the tests
+
+There are two ways to use the `Cypress` tests: through a terminal-based runner and through the `Cypress` UI. Both are started through `yarn` but they have different use cases.
+
+```bash
+yarn cypress run
+```
+
+You can start by running the tests directly from the terminal. This is the quickest way to make sure all views pass checks (or find out which ones do not). This is also the starting point for work on running `Cypress` in the CI.
+
+```bash
+yarn cypress open
+```
+
+This command simply opens the `Cypress` UI. From there, you can run all or some of the test suites with live reloading. This is a great way to understand why some tests are failing, especially when it comes to a11y violations.
+
+When there are a11y violations, an assertion fails and prints out a list in the `Cypress` UI. You can then click on a violation to print more information in the browser console.
+
+## Documentation reference
+
+- [List of all possible violations covered by `axe`](https://dequeuniversity.com/rules/axe/3.4)
+- [`Cypress` documentation](https://docs.cypress.io)
+- [`axe` and `Cypress` integration](https://github.com/avanslaars/cypress-axe)

website/versioned_docs/version-3.1.1/api/course-run-synchronization-api.md

@@ -0,0 +1,56 @@
+---
+id: course-run-synchronization-api
+title: Course run synchronization API
+sidebar_label: course run sync
+---
+
+API endpoint allowing remote systems to synchronize their course runs with a Richie instance.
+
+## Synchronization endpoint [/api/1.0/course-runs-sync]
+
+This documentation describes version "1.0" of this API endpoint.
+
+### Synchronize a course run [POST]
+
+It takes a JSON object containing the course run details:
+
+- resource_link: `https://lms.example.com/courses/course-v1:001+001+001/info` (string, required) -
+  url of the course syllabus on the LMS from which a unique course identifier can be extracted
+- start: `2018-02-01T06:00:00Z` (string, optional) - ISO 8601 date, when this session of the
+  course starts
+- end: `2018-02-28T06:00:00Z` (string, optional) - ISO 8601 date, when this session of the course
+  ends
+- enrollment_start: `2018-01-01T06:00:00Z` (string, optional) - ISO 8601 date, when enrollment
+  for this session of the course starts
+- enrollment_end: `2018-01-31T06:00:00Z` (string, optional) - ISO 8601 date, when enrollment for
+  this session of the course ends
+- languages: ['fr', 'en'] (array[string], required) - ISO 639-1 code (2 letters) for the course's
+  languages
+
+
++ Request (application/json)
+    + Headers
+        + Authorization: `SIG-HMAC-SHA256 xxxxxxx` (string, required) - Authorization header
+            containing the digest of the utf-8 encoded json representation of the submitted data
+            for the given secret key and SHA256 digest algorithm (see [synchronizing-course-runs]
+            for an example).
+    + Body
+            ```json
+            {
+                "resource_link": "https://lms.example.com/courses/course-v1:001+001+001/info",
+                "start": "2021-02-01T00:00:00Z",
+                "end": "2021-02-31T23:59:59Z",
+                "enrollment_start": "2021-01-01T00:00:00Z",
+                "enrollment_end": "2021-01-31T23:59:59Z",
+                "languages": ["en", "fr"]
+            }
+            ```
+
++ Response 200 (application/json)
+
+    + Body
+            ```json
+            {
+                "success": True
+            }
+            ```