Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Github IDs and core metadata #13

Merged
merged 3 commits into from
Jun 16, 2021
Merged

Github IDs and core metadata #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f0bf132
NEW Github unique identifiers
chillu Jun 16, 2021
d919177
NEW Core metadata (fixes #10)
chillu Jun 16, 2021
2f0ebc9
Fix missing ids
chillu Jun 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Silverstripe CMS Supported Modules Metadata

Used to generate the
[supported modules list](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/) on silverstripe.org,
and is the starting point for tooling such as
our ["Elvis" bug tracker](https://github.com/silverstripe/github-issue-search-client).

## Format

* `github`: String. Github repository name (incl. org)
* `gitlab`: String. Alternative gitlab repository name (incl. org)
* `composer`: String. Packagist/composer name
* `scrutinizer`: Boolean. Does this repo have Scrutinizer enabled?
* `addons`: Boolean. Does this module exist on addons.silverstripe.org?
* `type`: String. `supported-module` or `supported-dependency`
* `githubId` Number. The [id](https://docs.github.com/en/rest/reference/repos#get-a-repository) in Github. Used as a unique identifier.
* `isCore`. Boolean. Is this considered a direct dependency of `silverstripe/installer`, `silverstripe/recipe-cms` or `silverstripe/recipe-core`?

## Adding a repo

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

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