Skip to content

Commit ecc8eb5

Browse files
committed
added current validation performed by the server
1 parent e0a719a commit ecc8eb5

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,26 @@ colors`_ are supported too:
279279
280280
* <fg=blue>Read</> the documentation at <comment>https://symfony.com/doc</>
281281
282+
Validation
283+
----------
284+
285+
When submitting a recipe, several checks are automatically executed to validate
286+
the recipe:
287+
288+
* YAML files suffix must be `.yaml`, not `.yml`;
289+
* YAML files must be valid;
290+
* JSON files must be valid;
291+
* Aliases are only supported in the main repository, not the contrib one;
292+
* Aliases must not be already defined by another package;
293+
* All versions listed in `version_aliases` and the main version should be valid;
294+
* Version defined in the directory must be the oldest amongst those defined in `version_aliases`;
295+
* The package must exist on Packagist;
296+
* The package must have at least one version on Packagist;
297+
* The package must have an MIT or BSD license;
298+
* The package must be of type "symfony-bundle" if a bundle is registered in the manifest;
299+
* The package must have a registered bundle in the manifest if type is "symfony-bundle";
300+
* The package does not only register a bundle for all environments.
301+
282302
Full Example
283303
------------
284304

0 commit comments

Comments
 (0)