README

Metadata and some supporting PHP logic for determining which branches of various GitHub repositories relate to which versions of Silverstripe CMS.

Important

Only the main branch of this repository is maintained. Stable tags must be manually created from the main branch. There is no auto tagging via a GitHub action. All branches other than main are legacy and should not be referenced going forward.

You can fetch the JSON by simply fetching the raw copy of repositories.json file, e.g. https://raw.githubusercontent.com/silverstripe/supported-modules/main/repositories.json.

If you've included this module as a composer dependency then you can use SilverStripe\SupportedModules\MetaData::getAllRepositoryMetaData() which will fetch the latest version of the JSON file from raw.githubusercontent.com. There is a local copy of repositories.json in the module, though it is not guaranteed to be up to date, so only use this if fetching a fresh copy of this file is not viable.

Format

There are several sections in the repositories.json file, denoting different categories of repositories:

• supportedModules: Repositories representing supported modules. If cow cares about it, it should probably be in this category.
• workflow: Repositories which hold GitHub actions and workflows.
• tooling: Repositories used to help streamline Silverstripe CMS maintenance
• misc: All repositories we need to track which don't fit in one of the above categories.

Each of the above sections holds an array of JSON objects with the following data:

Adding a repo

You can easily retrieve the githubId via the following API call:

https://api.github.com/repos/my-org/my-repo