(Added) Introduce .gitattributes for efficient package management #34
Conversation
- Exclude test directories, meta files, and configuration files - Reduce package size for end-users and simplify deployment - Align with best practices for managing Composer packages - Improve efficiency of installations using `--prefer-dist` Introduced a .gitattributes file to specify files and directories that should be excluded from distribution archives, including: - Tests, to lighten the package for production use - Development-specific files (.gitignore, .github, etc.) - Configuration files for development tools (PHPUnit, PHPStan, etc.) This change aims to reduce the package size for end-users, streamline the deployment process, and enhance the efficiency of installations using the `--prefer-dist` option in Composer. It aligns with best practices for managing Composer packages.
WalkthroughWalkthroughThe recent update includes a new Changes
TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
|
PR Description updated to latest commit (c83c2ec)
|
Apply Sweep Rules to your PR?
This is an automated message generated by Sweep AI. |
|
Changelog updates: 2024-03-08Added
|
PR Code Suggestions
|
![codiumai-pr-agent-pro[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
|
Auto-approved PR |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #34 +/- ##
=========================================
Coverage 98.75% 98.75%
Complexity 26 26
=========================================
Files 1 1
Lines 80 80
=========================================
Hits 79 79
Misses 1 1 ☔ View full report in Codecov by Sentry. |
Add '/composer.lock' to .gitattributes export-ignore. This ensures that consumers of the library use their own 'composer.lock' file and have the latest versions of dependencies based on their project's requirements.
Configure Git to automatically convert line endings to LF on checkin and to CRLF on checkout for Windows. This ensures consistent line endings across different operating systems. Add the following rule to .gitattributes: * text=auto
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
User description
Summary
This merge request introduces a .gitattributes file to the project, aiming to streamline package management and deployment processes. By specifying files and directories that should be excluded from distribution archives, we reduce the package size for end-users and align with best practices for managing Composer packages. This change enhances the efficiency of installations using the
--prefer-distoption in Composer, focusing on a leaner, more efficient delivery of the project's production environment.Context and Background
To optimise our project's deployment and distribution process, it has become necessary to adopt strategies that minimise package size and remove unnecessary files from production environments. This improves the efficiency of deployments and secures the environment by reducing the attack surface.
Problem Description
Previously, our Composer packages included all files and directories in the repository, including tests, documentation, and configuration files for development tools. This resulted in bloated packages, increased deployment times, and potentially unnecessary exposure of development files in production environments.
Solution Description
The solution was to introduce a
.gitattributesfile to the repository. This file specifies which files and directories should be excluded from distribution archives created by Composer. The exclusion list includes:.gitignore,.github)PHPUnit,PHPStan)This approach aligns with industry best practices for Composer package management, ensuring that only the necessary files are included in production deployments.
List of Changes
Type
enhancement
Description
.gitattributesfile to streamline package management and deployment processes by excluding unnecessary files and directories from distribution archives.--prefer-distoption..gitignore,.github), and configuration files for development tools (e.g.,PHPUnit,PHPStan).Changes walkthrough
.gitattributes
Introduce .gitattributes for Efficient Package Management.gitattributes
.gitattributesto exclude specific directories and filesfrom distribution archives.
configuration and meta files.
Summary by CodeRabbit
.gitattributesfile for enhanced efficiency.