silverstripe-cms-meta

silverstripe-cms-meta

This package contains meta data about various Silverstripe CMS modules. If you need a consistent list of Silverstripe modules that you can import into a JS project, you can require this package.

Used by:

• Silverstripe CMS Squad Dashboard
• Silverstripe CMS Dashboard CLI

How to use

import {data as ssData} from 'silverstripe-cms-meta';

const filteredlist = ssData.filter({repo} => repo === 'silverstripe/silverstripe-framework');

const frameworkMeta = filteredlist[0];

console.dir(frameworkMeta)

The output will look something like this.

• repo is the name of the module on GitHub.
• name should match the packagist name for the module, if it differs from repo.
• core is for modules included in silverstripe/installer
• supported is for modules included in the CWP kitchen sink

{
  "repo": "silverstripe/silverstripe-framework",
  "name": "silverstripe/framework",
  "core": true,
  "supported": true
}

How to update the meta data

Do a PR updating src/lib/data.json.

Once the PR is merged, tag a new release in GitHub. There's a GitHub action that will automatically rebuild the package and publish it to NPM.

How to update release lines

There's bash script in the root of the project that allows you to generate a list of packages version that will be installed for a specific release. It can be call with:

bash buildReleaseSet.bash silverstripe/recipe-kitchen-sink 4.x-dev
bash buildReleaseSet.bash silverstripe/installer 4.x-dev

This will generate a JSON file under src/lib/release-et. From there, update src/index.ts to import the new data.