From 474195194e0bb02975db5afdbe0ee5e31edfc6d1 Mon Sep 17 00:00:00 2001 From: Ronak Pansuriya Date: Mon, 16 Nov 2026 12:48:08 +0100 Subject: [PATCH] feat: add publiccode.yml with automated weekly sync Add publiccode.yml so Open edX can be listed in the EU Open Source Solutions Catalogue. Add a weekly workflow that keeps softwareVersion, releaseDate, Python and Node.js in sync with the latest release tag, pyproject.toml and .nvmrc, and opens a PR when they change. --- .github/workflows/update-publiccode.yml | 55 ++++++++ publiccode.yml | 161 ++++++++++++++++++++++++ 2 files changed, 216 insertions(+) create mode 100644 .github/workflows/update-publiccode.yml create mode 100644 publiccode.yml diff --git a/.github/workflows/update-publiccode.yml b/.github/workflows/update-publiccode.yml new file mode 100644 index 000000000000..a9614ec1b01d --- /dev/null +++ b/.github/workflows/update-publiccode.yml @@ -0,0 +1,55 @@ +name: Update publiccode.yml + +# publiccode.yml feeds the EU Open Source Solutions Catalogue. Keep the values +# that already live elsewhere in this repo (Python, Node.js, latest release) +# fresh by opening a PR whenever they drift. + +on: + schedule: + - cron: "0 3 * * 2" + workflow_dispatch: + +permissions: + contents: write + pull-requests: write + +jobs: + update-publiccode: + # Don't run the weekly job on forks. + if: github.repository == 'openedx/openedx-platform' || github.event_name != 'schedule' + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v7 + with: + fetch-depth: 0 # the script reads release/* tags + + - uses: actions/setup-python@v6 + with: + python-version: "3.12" + + - name: Sync publiccode.yml from repo metadata + run: | + python_version=$(grep -oP '(?<=requires-python = ">=)\d+\.\d+' pyproject.toml) + node_version=$(grep -oP '^\d+' .nvmrc) + # Newest release/. tag (names are alphabetical) and its date. + release_tag=$(git tag --list 'release/*' | sed 's|release/||' | sort -V | tail -n 1) + release_date=$(git log -1 --format=%cs "release/${release_tag}") + + # Edit only the matching lines so comments and formatting stay untouched. + sed -i \ + -e "s|^softwareVersion: .*|softwareVersion: \"${release_tag}\"|" \ + -e "s|^releaseDate: .*|releaseDate: \"${release_date}\"|" \ + -e "/- name: Python$/{n;s|version: .*|version: \"${python_version}\"|}" \ + -e "/- name: Node.js$/{n;s|version: .*|version: \"${node_version}\"|}" \ + publiccode.yml + + - name: Open a pull request if anything changed + uses: peter-evans/create-pull-request@v8 + with: + branch: chore/update-publiccode + commit-message: "chore: update publiccode.yml" + title: "chore: update publiccode.yml" + body: | + Automated weekly sync of `publiccode.yml` with `pyproject.toml`, `.nvmrc` + and the latest `release/*` tag, using the workflow in `.github/workflows/update-publiccode.yml`. + delete-branch: true diff --git a/publiccode.yml b/publiccode.yml new file mode 100644 index 000000000000..21578fc72f55 --- /dev/null +++ b/publiccode.yml @@ -0,0 +1,161 @@ +# publiccode.yml for the Open edX platform +# +# publiccode.yml is a standard, machine-readable +# description of an open-source project. Public-sector catalogues read it from +# the repository root to list the project and show its metadata (license, +# description, dependencies, contact). This file is what lets Open edX be +# listed in the EU Open Source Solutions Catalogue. +# +# Location: root of https://github.com/openedx/openedx-platform +# Standard: https://publiccodeyml.github.io/v0/ +# Validate: https://publiccode-editor.developers.italia.it/ +# For listing in the EU Open Source Solutions Catalogue: +# https://interoperable-europe.ec.europa.eu/eu-oss-catalogue +# See also: https://elearningindustry.com/directory/elearning-software/open-edx + +publiccodeYmlVersion: "0" + +name: Open edX +url: "https://github.com/openedx/openedx-platform.git" +landingURL: "https://openedx.org" + +softwareVersion: "verawood.2" +releaseDate: "2026-10-29" +logo: "https://openedx.org/wp-content/uploads/2025/08/openedx-logo-2026.svg" + +platforms: + - web + +categories: + - learning-management-system + - educational-content + - content-management + +developmentStatus: stable +softwareType: "standalone/web" + +organisation: + uri: "https://www.axim.org" + name: Axim Collaborative + +intendedAudience: + scope: + - education + - research + +description: + en: + localisedName: Open edX + shortDescription: >- + Open-source learning platform to create, deliver and manage online + courses at any scale. + longDescription: >- + Open edX is a free, open-source teaching and learning platform stewarded + by Axim Collaborative, a nonprofit founded by Harvard and MIT. It is + developed together with a global community of contributors and service + providers. + + + The platform has two main parts: **Studio**, where course teams create + and manage learning content, and the **LMS**, where learners take + courses. It supports self-paced and instructor-led courses, many problem + and assessment types, certificates, cohorts, teams and learner reports. + It can be extended with XBlocks and plugins, and connects to other + systems through LTI and single sign-on. + + + Universities, governments, NGOs and companies use Open edX to run + training and education programmes. Organisations can host it on their + own infrastructure, for example with Tutor, the community-supported + Docker-based distribution, which helps them keep control of their data. + documentation: "https://docs.openedx.org" + apiDocumentation: "https://docs.openedx.org/projects/edx-platform/en/latest/references/lms_apis.html" + features: + - Course authoring in Studio + - Shared content libraries + - Self-paced and instructor-led courses + - Video, problems and open response assessments + - Prerequisite courses and subsections + - Course certificates + - Course content search + - Cohorts and teams + - LTI Advantage certified + - Single sign-on with third-party authentication + - Grade and learner reports + - Multi-language user interface + screenshots: + - "https://openedx.org/wp-content/uploads/2025/12/A-Powerful-Learning-Management-System-LMS-min.jpg" + - "https://openedx.org/wp-content/uploads/2025/12/Easily-Create-Courses-with-Our-Authoring-Studio-min.jpg" + - "https://openedx.org/wp-content/uploads/2025/12/Empower-Learning-with-the-Open-edX-Platform-min.jpg" + +legal: + license: AGPL-3.0-only + +maintenance: + type: community + contacts: + - name: Stefania Trabucchi + email: "stefania.trabucchi@abstract-technology.de" + affiliation: Abstract Technology GmbH + +localisation: + localisationReady: true + availableLanguages: + - en + - af-ZA + - ar + - az + - bo + - da + - de-DE + - el + - es-419 + - es-ES + - fa + - fr + - fr-CA + - he + - hi + - hu + - id + - it-IT + - ja + - lv + - pl + - pt-BR + - pt-PT + - ro + - ru + - sq + - sv + - sw + - th + - tr-TR + - uk + - uz + - vi + - zh-HK + +# Python and Node.js versions are kept in sync automatically from +# pyproject.toml and .nvmrc by the +# "Update publiccode.yml" workflow. softwareVersion and releaseDate follow the +# latest release/* git tag. The services below are the defaults installed by +# Tutor (https://github.com/overhangio/tutor) and are maintained by hand. +dependsOn: + open: + - name: Python + version: "3.12" + - name: Node.js + version: "24" + - name: MySQL + version: "8.4" + - name: MongoDB + version: "7.0" + - name: Redis + version: "7.4" + - name: Meilisearch + version: "1.36" + - name: Caddy + version: "2.11" + - name: Exim (SMTP relay) + version: "4.96"