From 33f725e99b8b678fc426eb425d9114eab46f4253 Mon Sep 17 00:00:00 2001 From: JamesRezo Date: Thu, 26 Nov 2015 16:31:49 +0100 Subject: [PATCH 1/4] Satis documentation updates --- .../handling-private-packages-with-satis.md | 28 ++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/doc/articles/handling-private-packages-with-satis.md b/doc/articles/handling-private-packages-with-satis.md index 4294de4fb..4b58a4137 100644 --- a/doc/articles/handling-private-packages-with-satis.md +++ b/doc/articles/handling-private-packages-with-satis.md @@ -220,10 +220,14 @@ following to your `satis.json`: #### Options explained - * `directory`: the location of the dist files (inside the `output-dir`) + * `directory`: required, the location of the dist files (inside the `output-dir`) * `format`: optional, `zip` (default) or `tar` * `prefix-url`: optional, location of the downloads, homepage (from `satis.json`) followed by `directory` by default * `skip-dev`: optional, `false` by default, when enabled (`true`) satis will not create downloads for branches +* `absolute-directory`: optional, a _local_ directory where the dist files are dumped instead of `outpur-dir`/`directory` +* `whitelist`: optional, if set as a list of package names, satis will only dump the dist files of these packages +* `blacklist`: optional, if set as a list of package names, satis will not dump the dist files of these packages +* `checksum`: optional, `true` by default, when disabled (`false`) satis will not provide the sha1 checksum for the dist files Once enabled, all downloads (include those from GitHub and BitBucket) will be replaced with a _local_ version. @@ -235,6 +239,28 @@ bucket or on a CDN host. A CDN would drastically improve download times and ther Example: A `prefix-url` of `https://my-bucket.s3.amazonaws.com` (and `directory` set to `dist`) creates download URLs which look like the following: `https://my-bucket.s3.amazonaws.com/dist/vendor-package-version-ref.zip`. +### Web outputs + +* `output-html`: optional, `true` by default, when disabled (`false`) satis will not generate the `output-dir`/index.html page. +* `twig-template`: optional, a path to a personalized [Twig](http://twig.sensiolabs.org/) template for the `output-dir`/index.html page. + +### Abandoned packages + +To enable your satis installation to indicate that some packages are abandoned, add the following to your `satis.json`: + +```json +{ + "abandoned": { + "company/package": true, + "company/package2": "company/newpackage" + } +} +``` + +The `true` value indicates that the package is truly abandoned while the `"company/newpackage"` value specifies that the package is replaced by +the `company/newpackage` package. + +Note that all packages set as abandoned in their own `composer.json` file will be marked abandoned as well. ### Resolving dependencies From b4e0d1e879d771afbf543b138de578aa66352d74 Mon Sep 17 00:00:00 2001 From: JamesRezo Date: Thu, 26 Nov 2015 16:48:17 +0100 Subject: [PATCH 2/4] Indentation --- doc/articles/handling-private-packages-with-satis.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/articles/handling-private-packages-with-satis.md b/doc/articles/handling-private-packages-with-satis.md index 4b58a4137..d6ba87a63 100644 --- a/doc/articles/handling-private-packages-with-satis.md +++ b/doc/articles/handling-private-packages-with-satis.md @@ -224,10 +224,10 @@ following to your `satis.json`: * `format`: optional, `zip` (default) or `tar` * `prefix-url`: optional, location of the downloads, homepage (from `satis.json`) followed by `directory` by default * `skip-dev`: optional, `false` by default, when enabled (`true`) satis will not create downloads for branches -* `absolute-directory`: optional, a _local_ directory where the dist files are dumped instead of `outpur-dir`/`directory` -* `whitelist`: optional, if set as a list of package names, satis will only dump the dist files of these packages -* `blacklist`: optional, if set as a list of package names, satis will not dump the dist files of these packages -* `checksum`: optional, `true` by default, when disabled (`false`) satis will not provide the sha1 checksum for the dist files + * `absolute-directory`: optional, a _local_ directory where the dist files are dumped instead of `outpur-dir`/`directory` + * `whitelist`: optional, if set as a list of package names, satis will only dump the dist files of these packages + * `blacklist`: optional, if set as a list of package names, satis will not dump the dist files of these packages + * `checksum`: optional, `true` by default, when disabled (`false`) satis will not provide the sha1 checksum for the dist files Once enabled, all downloads (include those from GitHub and BitBucket) will be replaced with a _local_ version. @@ -241,8 +241,8 @@ which look like the following: `https://my-bucket.s3.amazonaws.com/dist/vendor-p ### Web outputs -* `output-html`: optional, `true` by default, when disabled (`false`) satis will not generate the `output-dir`/index.html page. -* `twig-template`: optional, a path to a personalized [Twig](http://twig.sensiolabs.org/) template for the `output-dir`/index.html page. + * `output-html`: optional, `true` by default, when disabled (`false`) satis will not generate the `output-dir`/index.html page. + * `twig-template`: optional, a path to a personalized [Twig](http://twig.sensiolabs.org/) template for the `output-dir`/index.html page. ### Abandoned packages From b63cfb7b379df5a26927ea54adadceabd04a80fd Mon Sep 17 00:00:00 2001 From: JamesRezo Date: Fri, 27 Nov 2015 09:30:04 +0100 Subject: [PATCH 3/4] Other options --- doc/articles/handling-private-packages-with-satis.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/articles/handling-private-packages-with-satis.md b/doc/articles/handling-private-packages-with-satis.md index d6ba87a63..8ae789fb4 100644 --- a/doc/articles/handling-private-packages-with-satis.md +++ b/doc/articles/handling-private-packages-with-satis.md @@ -279,3 +279,10 @@ When searching for packages, satis will attempt to resolve all the required pack Therefore, if you are requiring a package from Packagist, you will need to define it in your `satis.json`. Dev dependencies are packaged only if the `require-dev-dependencies` parameter is set to true. + +### Other options + + * `output-dir`: optional, defines where to output the repository files + if not provided as an argument when calling the `build` command. + * `config`: optional, lets you define all config options from composer, except `archive-format` and `archive-dir` as the configuration is done through [archive](#downloads) instead. See + (http://getcomposer.org/doc/04-schema.md#config) From ff93bd5bf2eef132e84ea2e204996064be4ff0f9 Mon Sep 17 00:00:00 2001 From: JamesRezo Date: Fri, 27 Nov 2015 14:22:50 +0100 Subject: [PATCH 4/4] Typo again --- doc/articles/handling-private-packages-with-satis.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/articles/handling-private-packages-with-satis.md b/doc/articles/handling-private-packages-with-satis.md index 8ae789fb4..6dce414a3 100644 --- a/doc/articles/handling-private-packages-with-satis.md +++ b/doc/articles/handling-private-packages-with-satis.md @@ -224,7 +224,7 @@ following to your `satis.json`: * `format`: optional, `zip` (default) or `tar` * `prefix-url`: optional, location of the downloads, homepage (from `satis.json`) followed by `directory` by default * `skip-dev`: optional, `false` by default, when enabled (`true`) satis will not create downloads for branches - * `absolute-directory`: optional, a _local_ directory where the dist files are dumped instead of `outpur-dir`/`directory` + * `absolute-directory`: optional, a _local_ directory where the dist files are dumped instead of `output-dir`/`directory` * `whitelist`: optional, if set as a list of package names, satis will only dump the dist files of these packages * `blacklist`: optional, if set as a list of package names, satis will not dump the dist files of these packages * `checksum`: optional, `true` by default, when disabled (`false`) satis will not provide the sha1 checksum for the dist files