Browse Source

Merge pull request #7131 from pylebecq/doc-abandoned-prop

Add abandoned property in composer schema documentation
Jordi Boggiano 7 years ago
parent
commit
eaf725d6a5
1 changed files with 16 additions and 0 deletions
  1. 16 0
      doc/04-schema.md

+ 16 - 0
doc/04-schema.md

@@ -864,6 +864,22 @@ The example will include `/dir/foo/bar/file`, `/foo/bar/baz`, `/file.php`,
 
 Optional.
 
+### abandoned
+
+Indicates whether this package has been abandoned.
+
+It can be boolean or a package name/URL pointing to a recommended alternative.
+
+Examples:
+
+Use `"abandoned": true` to indicates this package is abandoned.
+Use `"abandoned": "monolog/monolog"` to indicates this package is abandoned and the
+recommended alternative is  `monolog/monolog`.
+
+Defaults to false.
+
+Optional.
+
 ### non-feature-branches
 
 A list of regex patterns of branch names that are non-numeric (e.g. "latest" or something),