silverstripe / supported-modules
Metadata about Silverstripe CMS supported modules and other repositories maintained by Silverstripe
Installs: 29 202
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 6
Forks: 3
Open Issues: 0
Requires
- php: ^8.1
- composer/semver: ^3.4
Requires (Dev)
- phpunit/phpunit: ^9.6
This package is auto-updated.
Last update: 2024-09-10 00:55:57 UTC
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.
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 compser dependency then you can use SilverStripe\SupportedModules\MetaData::getAllRepositoryMetaData()
which will fetch the latest version of the JSON file from raw.githubusercontent.com.
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 maintenancemisc
: 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