Skip to content

Commit 119e307

Browse files
committed
Exclude README.rst from package archives
README.rst is a symlink to docs/guide.txt, which is the canonical users guide. Packages containing symlinks appear to cause problems on Windows so exclude it from composer archive creation. I think this won't prevent README content from being displayed on packagist.org because that site apparently fetches READMEs directly from GitHub, if it does cause problems, we can also add the "readme" property: https://getcomposer.org/doc/04-schema.md#readme
1 parent 7f6f5a1 commit 119e307

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

composer.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
"php": ">=7.4",
1212
"pear/pear_exception": "1.0.1 || 1.0.2"
1313
},
14+
"archive": {
15+
"exclude": ["/README.rst"]
16+
},
1417
"autoload": {
1518
"psr-0": {
1619
"Log": "./"

0 commit comments

Comments
 (0)