Skip to content

Optimize .gitattributes for smaller dist, delete non-existent files#73

Merged
roxblnfk merged 4 commits intoroadrunner-php:4.xfrom
Kaspiman:chore-gitattributes
May 20, 2025
Merged

Optimize .gitattributes for smaller dist, delete non-existent files#73
roxblnfk merged 4 commits intoroadrunner-php:4.xfrom
Kaspiman:chore-gitattributes

Conversation

@Kaspiman
Copy link
Copy Markdown
Contributor

@Kaspiman Kaspiman commented May 20, 2025

Q A
Bugfix?
Breaks BC?
New feature?
Issues #...
Docs PR spiral/docs#...

Summary by CodeRabbit

  • Chores
    • Refined export rules for project packaging by updating which files and directories are excluded from archives, improving maintainability without affecting user experience.

Signed-off-by: Vladimir Plakhotnikov <embargo2710@gmail.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented May 20, 2025

Walkthrough

The .gitattributes file was simplified by replacing explicit export-ignore entries for specific files and directories with broader patterns. It added a global pattern to ignore all hidden files and directories, introduced wildcard ignores for root YAML and XML files, and adjusted the tests directory ignore to include a trailing slash. A * text=auto attribute was also added.

Changes

File(s) Change Summary
.gitattributes Simplified export-ignore rules by adding /.* for all hidden files and directories at root, wildcard ignores for /*.yml, /*.xml, and /*.xml.dist; changed tests to /tests/; removed explicit ignores for .github, example, generated, and specific files; added * text=auto attribute.

Poem

In the garden of .git, changes bloom anew,
Paths trimmed and files shuffled, a tidy debut.
Some old friends departed, new ones join the show,
Exporting just what's needed, letting clutter go.
With every hop and skip in this tidy spring,
The archive grows lighter—what joy this will bring! 🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 9fe3d18 and 0973917.

📒 Files selected for processing (1)
  • .gitattributes (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .gitattributes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
.gitattributes (1)

1-2: Use explicit directory patterns for clarity.

Omitting leading slashes works, but it’s more readable and less error-prone to append a trailing slash on directory patterns so Git knows you mean the directory itself. For example:

-.github export-ignore
-tests export-ignore
+.github/ export-ignore
+tests/ export-ignore

Also, confirm that removing example/ and generated/ from the export-ignore list is intentional—those directories will now be included in archive exports unless they no longer exist.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 52ae1fb and b17c9ae.

📒 Files selected for processing (1)
  • .gitattributes (1 hunks)
🔇 Additional comments (1)
.gitattributes (1)

6-7:

Details

✅ Verification successful

Verify the presence of newly ignored files.

You added .styleci.yml, codecov.yml, and psalm.xml to the export-ignore list. Double-check that these files actually exist at the repository root; if they don’t, the patterns won’t match anything.

Also applies to: 9-9


🏁 Script executed:

#!/bin/bash
for f in .styleci.yml codecov.yml psalm.xml; do
  if [[ ! -e "$f" ]]; then
    echo "Missing: $f"
    exit 1
  fi
done
echo "✅ All files exist"

Length of output: 256


Verified: Ignored files exist
The .styleci.yml, codecov.yml, and psalm.xml files are all present at the repository root, so the export-ignore entries in .gitattributes will match as intended.

Copy link
Copy Markdown
Member

@roxblnfk roxblnfk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will be better to remove .stylecy.yml (with badge in readme)

Kaspiman added 2 commits May 20, 2025 16:05
Signed-off-by: Vladimir Plakhotnikov <embargo2710@gmail.com>
Signed-off-by: Vladimir Plakhotnikov <embargo2710@gmail.com>
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (3)
.gitattributes (3)

3-3: Verify hidden file export-ignore scope or broaden if needed.

The /.* export-ignore pattern cleanly replaces multiple explicit entries by excluding all hidden files and directories at the repository root. Note it only applies to top-level hidden items; if you need to ignore hidden files in subdirectories as well, consider using **/.* export-ignore.


5-5: Consider adding support for .yaml files.

You currently ignore only *.yml at the root. If your project also includes *.yaml configurations, you may want to add:

/*.yaml    export-ignore

to prevent those from being packaged.


6-6: Optional: consolidate extension patterns.

For brevity and easier maintenance, you could merge multiple root-level extension ignores into a single brace-expansion pattern, for example:

/*.{yml,yaml,xml}    export-ignore

This reduces repetition while achieving the same effect.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 2130d28 and 9fe3d18.

📒 Files selected for processing (1)
  • .gitattributes (1 hunks)
🔇 Additional comments (2)
.gitattributes (2)

1-1: Automatic text normalization is correctly enabled.

The * text=auto directive applies Git’s end-of-line normalization to all files, ensuring consistent line endings across platforms—a recommended best practice.


4-4: Tests directory export-ignore is correctly specified.

Using /tests/ export-ignore with a trailing slash ensures the entire tests directory is excluded from the distribution archive, which aligns with the goal of shrinking the package.

@Kaspiman
Copy link
Copy Markdown
Contributor Author

It will be better to remove .stylecy.yml (with badge in readme)

Maybe i will do it in new PR?

@roxblnfk
Copy link
Copy Markdown
Member

Maybe i will do it in new PR?

Up to you

Signed-off-by: Vladimir Plakhotnikov <embargo2710@gmail.com>
@roxblnfk roxblnfk merged commit 1938689 into roadrunner-php:4.x May 20, 2025
1 check passed
@Kaspiman Kaspiman deleted the chore-gitattributes branch May 20, 2025 11:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants