Exclude non-essential files using .gitattributes
#6107
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
| /features export-ignore | ||
| /bin export-ignore | ||
| /phpunit.xml.dist export-ignore | ||
| /composer.json export-ignore |
There was a problem hiding this comment.
| /composer.json export-ignore |
There's an argument in favour of keeping composer.json so people can quickly read it to better understand the package.
You should also keep and/or link configuration files, as for example, the composer.json file in order to allow others to review, study, and yes, fork this code.
https://developer.wordpress.org/plugins/wordpress-org/common-issues/#included-unneeded-folders
| /composer.lock export-ignore | ||
| /utils export-ignore | ||
| /.phpcs.xml.dist export-ignore | ||
| /.editorconfig export-ignore |
There was a problem hiding this comment.
I think these are also valid to exclude, being only dev related files:
| /.editorconfig export-ignore | |
| /.actrc export-ignore | |
| /.editorconfig export-ignore | |
| /.gitattributes export-ignore | |
| /.gitignore export-ignore | |
| /.mailmap export-ignore | |
| /.behat.yml export-ignore | |
| /phpcs.xml.dist export-ignore | |
| /phpstan.neon.dist export-ignore |
| /bin export-ignore | ||
| /phpunit.xml.dist export-ignore | ||
| /composer.json export-ignore | ||
| /composer.lock export-ignore |
There was a problem hiding this comment.
| /composer.lock export-ignore |
There is no composer.lock in this repository.
Line 13 in 03d30d4
| /.github export-ignore | ||
| /tests export-ignore | ||
| /features export-ignore | ||
| /bin export-ignore |
There was a problem hiding this comment.
| /bin export-ignore |
I think excluding /bin would mean vendor/bin/wp would not work when WP CLI is installed via Composer.
Lines 54 to 57 in 03d30d4
.gitattributes
|
If we find this useful, we should (automatically) add this to all our repos. Would save a lot of bandwidth :) Wonder how this affects https://github.com/wp-cli/wp-cli-dev though |
|
I think {
"name": "wp-cli/wp-cli-dev",
"config": {
"preferred-install": "source"
}
}"preferred-install": {
"type": ["string", "object"],
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or an object of {\"pattern\": \"preference\"}.",
"additionalProperties": {
"type": ["string"]
}
},
I haven't tested it yet. |
Summary
This PR adds a
.gitattributesfile to exclude development-only and non-essential files from distribution packages. This helps reduce package size and ensures that only relevant files are included when the project is exported or packaged via Composer.Changes Made
.gitattributesto exclude:Benefits
Related References
.gitattributes: https://getcomposer.org/doc/articles/vendor-binaries.md#excluding-files-from-classmaps