NEW Use a single-source-of-truth to determine version mapping #107
Conversation
| $versions = array_keys($config['versions']); | ||
|
|
||
| foreach ($versions as $version) { | ||
| $modulesUrl = "https://raw.githubusercontent.com/silverstripe/supported-modules/$version/modules.json"; |
There was a problem hiding this comment.
This requires the supported-modules PRs to be merged to work correctly - but if you want to test this locally in the mean time you can replace that one URL with this code:
switch ($version) {
case '5':
$modulesUrl = 'https://raw.githubusercontent.com/silverstripe/supported-modules/e9c9d44a6833bda035d6a3182effd167ab499549/modules.json';
break;
case '4':
$modulesUrl = 'https://raw.githubusercontent.com/silverstripe/supported-modules/daa19e8c279f599088ba12b2a91b9a51cfbc5eb2/modules.json';
break;
case '3':
$modulesUrl = 'https://raw.githubusercontent.com/silverstripe/supported-modules/30ceab854f964f4488f2834b80fc4d56f464e9c2/modules.json';
break;
}| bin/docs checkout -v \ | ||
| && DOCTUM_COMPOSER_AUTOLOAD_FILE='./vendor/autoload.php' ./vendor/bin/doctum.php --version \ | ||
| && DOCTUM_COMPOSER_AUTOLOAD_FILE='./vendor/autoload.php' ./vendor/bin/doctum.php --ignore-parse-errors --force -v update conf/doctum.php |
There was a problem hiding this comment.
We shouldn't try the doctum code if we failed to build out the version map.
GuySartorelli
force-pushed
the
pulls/master/supported-modules
branch
2 times, most recently
from
038d868
to
e127ab5
Compare
| "phpunit/phpunit": "^7", | ||
| "phpunit/phpunit": "^8.5", |
There was a problem hiding this comment.
Needed to use $this->expectWarning() in a test.
| 'silverstripe/graphql/src/Extensions/IntrospectionProvider.php', | ||
| 0 | ||
| ); | ||
| public function provideGetRepoUrl() |
There was a problem hiding this comment.
These are all the same tests that were happening before (except the graphql 3 one which was silly - that's not a valid mapping) plus one for CMS 5 and 3 just so we have one for each of the three mapped versions.
| public static function setUpBeforeClass(): void | ||
| { | ||
| $config = Config::getConfig(); | ||
| $filePath = Config::configPath($config['paths']['versionmap']); | ||
| if (file_exists($filePath)) { | ||
| self::$fileContent = file_get_contents($filePath); | ||
| unlink($filePath); | ||
| } | ||
| file_put_contents($filePath, json_encode([ |
There was a problem hiding this comment.
We need to make sure there's some mapping available to test against. But if you're running tests locally you may already have a map there so we make sure to keep that and restore it after the test.
| /** | ||
| * Regex patterns for github repositories that should be ignored. | ||
| * These are repositories that don't have relevant API. | ||
| */ | ||
| private array $ignoreModulePatterns = [ | ||
| '/^silverstripe\/developer-docs$/', | ||
| '/^silverstripe\/installer$/', | ||
| '/^silverstripe-themes\/simple$/', | ||
| '/^silverstripe\/vendor-plugin$/', | ||
| '/^silverstripe\/recipe-.*/', | ||
| '/-theme$/', | ||
| ]; |
There was a problem hiding this comment.
These are repositories which either have no PHP code at all, or their PHP code isn't really relevant.
The second part of that might be fairly subjective though.... feel free to recommend changes here if you think of any changes that are appropriate.
GuySartorelli
force-pushed
the
pulls/master/supported-modules
branch
from
e127ab5
to
7b0213d
Compare
Issue