Skip to content

feat: add publiccode.yml with automated weekly sync - #39377

Open
ronakpansuriya wants to merge 1 commit into
openedx:masterfrom
Abstract-Tech:feat/publiccode-yml
Open

ronakpansuriya wants to merge 1 commit into
openedx:masterfrom
Abstract-Tech:feat/publiccode-yml

Conversation

@ronakpansuriya

Copy link
Copy Markdown

Description

Adds a publiccode.yml file to the repo root so Open edX can be listed in the EU Open Source Solutions Catalogue. The EC OSPO team confirmed that a valid publiccode.yml in the repo root is the only prerequisite. The catalogue reads it to build the entry automatically. See the publiccode.yml spec.

The file also comes with a weekly workflow (.github/workflows/update-publiccode.yml) that keeps it up to date from metadata already in the repo, and opens a PR if anything changed:

  • softwareVersion and releaseDate come from the newest release/* git tag
  • the Python version comes from requires-python in pyproject.toml
  • the Node.js version comes from .nvmrc

It runs on Tuesdays, an hour after the requirements upgrade, and can also be run manually. It only rewrites those lines, so comments and formatting stay as they are. It does not run on forks. The service versions (MySQL, MongoDB, Redis, Meilisearch, Caddy, Exim) are the Tutor defaults and are maintained by hand, because the repo does not record them precisely.

The maintainer contact is Abstract Technology, since the catalogue is aimed at the European public sector. It is only a contact for the catalogue entry, not a claim of stewardship. Axim Collaborative remains the steward, and the contact can be changed if the community prefers.

This only adds repo metadata, no application code changes, so no user roles are affected.

Supporting information

Forum discussion: Proposal: add publiccode.yml to openedx-platform for EU Open Source Solutions Catalogue listing

Testing instructions

  • The file passes the official publiccode-parser with no errors or warnings.
  • I ran the workflow's update step locally against a file with outdated values. It restored them and changed only those lines, and a second run changed nothing.
  • After merging, run "Update publiccode.yml" once with "Run workflow" to check that the PR creation step works.

Deadline

None.

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.
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @ronakpansuriya!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform-oncall.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 16, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Nov 16, 2026
@CodeWithEmad
CodeWithEmad requested a review from feanil November 16, 2026 12:16
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Nov 16, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

2 participants