Repository navigation
feat: add publiccode.yml with automated weekly sync - #39377
ronakpansuriya wants to merge 1 commit into
Conversation
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.
|
Thanks for the pull request, @ronakpansuriya! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Description
Adds a
publiccode.ymlfile to the repo root so Open edX can be listed in the EU Open Source Solutions Catalogue. The EC OSPO team confirmed that a validpubliccode.ymlin 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:softwareVersionandreleaseDatecome from the newestrelease/*git tagrequires-pythoninpyproject.toml.nvmrcIt 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
Deadline
None.