1
0
Fork 0

Fix docs for issue composer/satis#656 (#11005)

pull/11009/head
Ralf Lang 2022-08-17 23:24:40 +02:00 committed by GitHub
parent 6b31fbec01
commit 20b3e3e79c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions

View File

@ -34,9 +34,11 @@ packages, or your own. You can get it from
For example let's assume you have a few packages you want to reuse across your For example let's assume you have a few packages you want to reuse across your
company but don't really want to open-source. You would first define a Satis company but don't really want to open-source. You would first define a Satis
configuration: a json file with an arbitrary name that lists your curated configuration: a json file that lists your curated
[repositories](../05-repositories.md). [repositories](../05-repositories.md).
The default file name is satis.json but it could be anything you like.
Here is an example configuration, you see that it holds a few VCS repositories, Here is an example configuration, you see that it holds a few VCS repositories,
but those could be any types of [repositories](../05-repositories.md). Then it but those could be any types of [repositories](../05-repositories.md). Then it
uses `"require-all": true` which selects all versions of all packages in the uses `"require-all": true` which selects all versions of all packages in the
@ -46,7 +48,7 @@ The default file Satis looks for is `satis.json` in the root of the repository.
```json ```json
{ {
"name": "My Repository", "name": "my/repository",
"homepage": "http://packages.example.org", "homepage": "http://packages.example.org",
"repositories": [ "repositories": [
{ "type": "vcs", "url": "https://github.com/mycompany/privaterepo" }, { "type": "vcs", "url": "https://github.com/mycompany/privaterepo" },
@ -337,4 +339,4 @@ is set to true.
[ssl context options]: https://secure.php.net/manual/en/context.ssl.php [ssl context options]: https://secure.php.net/manual/en/context.ssl.php
[Twig]: https://twig.sensiolabs.org/ [Twig]: https://twig.sensiolabs.org/
[config schema]: https://getcomposer.org/doc/04-schema.md#config [config schema]: https://getcomposer.org/doc/04-schema.md#config
[notify-batch]: https://getcomposer.org/doc/05-repositories.md#notify-batch [notify-batch]: https://getcomposer.org/doc/05-repositories.md#notify-batch