Skip to content

Added .gitattributes files to root and all components #26472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

martinssipenko
Copy link
Contributor

Q A
Branch? 4.0
Bug fix? no
New feature? not realy
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets n/a
License MIT
Doc PR n/a

This change adds .gitattributes files in all components.

The .gitattributes file allows you to configure several things, but the most important thing related to composer is the ability to not include certain files and folders into your release. In short, this should slightly reduce the size of symfony component packages by excluding few files from them.

@jakzal
Copy link
Contributor

jakzal commented Mar 9, 2018

@martinssipenko this is rather controversial and has been rejected many times before. Please see #25414 and https://github.com/symfony/symfony/search?q=gitattributes&type=Issues for past discussions. Closing for now as we didn't come to an agreement.

@jakzal jakzal closed this Mar 9, 2018
@martinssipenko martinssipenko deleted the gitattributes branch March 9, 2018 16:07
fabpot added a commit that referenced this pull request Sep 16, 2019
…dist" (Nyholm)

This PR was merged into the 4.4 branch.

Discussion
----------

Adding .gitattributes to remove Tests directory from "dist"

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no?
| Tickets       |
| License       | MIT
| Doc PR        |

This is a controversial topic that have been mentioned before. We recently had some discussions on Slack about it and the community not in an agreement. This was asked back in 2014 already.

Im making this PR again, because I think this will help more people than it hurts to keep the tests in the "dist" version.

### Reasons for keeping the tests with the source

* You can look at the tests to understand how the code works
* It is convenient

In the past there were an argument of people might depend on Symfony's classes in Tests. That is no longer the case since we moved reusable classes from Tests to Test.

### Reasons for removing them (merging this PR)

* There should be difference between `composer update --prefer-source` and `composer update --prefer-dist`
* Smaller packages when deploying with Docker or on Serverless.
* Static analysis tools will not complain on PHP syntax errors in our tests ([example](https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/DependencyInjection/Tests/Fixtures/xml/xml_with_wrong_ext.php))

## How to decide?

Merging this PR or not is tricky because no side has a solid technical argument. It is basically just personal preference. Please give this PR a 👍 or 👎 if you want to give your opinion.

## Other PRs and issues related to this:

Add .gitattributes file (#29277)
Added .gitattributes files to root and all components (#26472)
Exclude non-essential files from Composer package (#25414)
[HttpFoundation] optimize files for distribution (#24427)
Add .gitattributes files (#23926)
[Suggestion] Adding .gitattributes to ignore unnecessary folders and files for production env (#20057)
Add lightweight and root only .gitattributes (#18004)
Add .gitattributes to exclude tests from ZIPs (#17995)
[RFC] Move tests out of the source and source out of the tests (#17749)
Removal of development & testing files using .gitattributes (#16174)
Please add .gitattributes files and fix line endings (#13521)
making use of .gitattributes (#11810)

## Workarounds

There are workarounds for both sides. Example:

### Workaround if merged

* `composer update --prefer-source`

### Workaround if closed

* `find vendor/symfony -name "Tests" -type d -exec rm -r "{}" \;`
* editorconfig/editorconfig#228
* https://github.com/dg/composer-cleaner

Commits
-------

ac7dc24 Adding .gitattributes to remove Tests directory from "dist"
symfony-splitter pushed a commit to symfony/mailer that referenced this pull request Sep 16, 2019
…dist" (Nyholm)

This PR was merged into the 4.4 branch.

Discussion
----------

Adding .gitattributes to remove Tests directory from "dist"

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no?
| Tickets       |
| License       | MIT
| Doc PR        |

This is a controversial topic that have been mentioned before. We recently had some discussions on Slack about it and the community not in an agreement. This was asked back in 2014 already.

Im making this PR again, because I think this will help more people than it hurts to keep the tests in the "dist" version.

### Reasons for keeping the tests with the source

* You can look at the tests to understand how the code works
* It is convenient

In the past there were an argument of people might depend on Symfony's classes in Tests. That is no longer the case since we moved reusable classes from Tests to Test.

### Reasons for removing them (merging this PR)

* There should be difference between `composer update --prefer-source` and `composer update --prefer-dist`
* Smaller packages when deploying with Docker or on Serverless.
* Static analysis tools will not complain on PHP syntax errors in our tests ([example](https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/DependencyInjection/Tests/Fixtures/xml/xml_with_wrong_ext.php))

## How to decide?

Merging this PR or not is tricky because no side has a solid technical argument. It is basically just personal preference. Please give this PR a 👍 or 👎 if you want to give your opinion.

## Other PRs and issues related to this:

Add .gitattributes file (symfony/symfony#29277)
Added .gitattributes files to root and all components (symfony/symfony#26472)
Exclude non-essential files from Composer package (symfony/symfony#25414)
[HttpFoundation] optimize files for distribution (symfony/symfony#24427)
Add .gitattributes files (symfony/symfony#23926)
[Suggestion] Adding .gitattributes to ignore unnecessary folders and files for production env (symfony/symfony#20057)
Add lightweight and root only .gitattributes (symfony/symfony#18004)
Add .gitattributes to exclude tests from ZIPs (symfony/symfony#17995)
[RFC] Move tests out of the source and source out of the tests (symfony/symfony#17749)
Removal of development & testing files using .gitattributes (symfony/symfony#16174)
Please add .gitattributes files and fix line endings (symfony/symfony#13521)
making use of .gitattributes (symfony/symfony#11810)

## Workarounds

There are workarounds for both sides. Example:

### Workaround if merged

* `composer update --prefer-source`

### Workaround if closed

* `find vendor/symfony -name "Tests" -type d -exec rm -r "{}" \;`
* editorconfig/editorconfig#228
* https://github.com/dg/composer-cleaner

Commits
-------

ac7dc24bcb Adding .gitattributes to remove Tests directory from "dist"
symfony-splitter pushed a commit to symfony/web-profiler-bundle that referenced this pull request Sep 16, 2019
…dist" (Nyholm)

This PR was merged into the 4.4 branch.

Discussion
----------

Adding .gitattributes to remove Tests directory from "dist"

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no?
| Tickets       |
| License       | MIT
| Doc PR        |

This is a controversial topic that have been mentioned before. We recently had some discussions on Slack about it and the community not in an agreement. This was asked back in 2014 already.

Im making this PR again, because I think this will help more people than it hurts to keep the tests in the "dist" version.

### Reasons for keeping the tests with the source

* You can look at the tests to understand how the code works
* It is convenient

In the past there were an argument of people might depend on Symfony's classes in Tests. That is no longer the case since we moved reusable classes from Tests to Test.

### Reasons for removing them (merging this PR)

* There should be difference between `composer update --prefer-source` and `composer update --prefer-dist`
* Smaller packages when deploying with Docker or on Serverless.
* Static analysis tools will not complain on PHP syntax errors in our tests ([example](https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/DependencyInjection/Tests/Fixtures/xml/xml_with_wrong_ext.php))

## How to decide?

Merging this PR or not is tricky because no side has a solid technical argument. It is basically just personal preference. Please give this PR a 👍 or 👎 if you want to give your opinion.

## Other PRs and issues related to this:

Add .gitattributes file (symfony/symfony#29277)
Added .gitattributes files to root and all components (symfony/symfony#26472)
Exclude non-essential files from Composer package (symfony/symfony#25414)
[HttpFoundation] optimize files for distribution (symfony/symfony#24427)
Add .gitattributes files (symfony/symfony#23926)
[Suggestion] Adding .gitattributes to ignore unnecessary folders and files for production env (symfony/symfony#20057)
Add lightweight and root only .gitattributes (symfony/symfony#18004)
Add .gitattributes to exclude tests from ZIPs (symfony/symfony#17995)
[RFC] Move tests out of the source and source out of the tests (symfony/symfony#17749)
Removal of development & testing files using .gitattributes (symfony/symfony#16174)
Please add .gitattributes files and fix line endings (symfony/symfony#13521)
making use of .gitattributes (symfony/symfony#11810)

## Workarounds

There are workarounds for both sides. Example:

### Workaround if merged

* `composer update --prefer-source`

### Workaround if closed

* `find vendor/symfony -name "Tests" -type d -exec rm -r "{}" \;`
* editorconfig/editorconfig#228
* https://github.com/dg/composer-cleaner

Commits
-------

ac7dc24bcb Adding .gitattributes to remove Tests directory from "dist"
symfony-splitter pushed a commit to symfony/framework-bundle that referenced this pull request Sep 16, 2019
…dist" (Nyholm)

This PR was merged into the 4.4 branch.

Discussion
----------

Adding .gitattributes to remove Tests directory from "dist"

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no?
| Tickets       |
| License       | MIT
| Doc PR        |

This is a controversial topic that have been mentioned before. We recently had some discussions on Slack about it and the community not in an agreement. This was asked back in 2014 already.

Im making this PR again, because I think this will help more people than it hurts to keep the tests in the "dist" version.

### Reasons for keeping the tests with the source

* You can look at the tests to understand how the code works
* It is convenient

In the past there were an argument of people might depend on Symfony's classes in Tests. That is no longer the case since we moved reusable classes from Tests to Test.

### Reasons for removing them (merging this PR)

* There should be difference between `composer update --prefer-source` and `composer update --prefer-dist`
* Smaller packages when deploying with Docker or on Serverless.
* Static analysis tools will not complain on PHP syntax errors in our tests ([example](https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/DependencyInjection/Tests/Fixtures/xml/xml_with_wrong_ext.php))

## How to decide?

Merging this PR or not is tricky because no side has a solid technical argument. It is basically just personal preference. Please give this PR a 👍 or 👎 if you want to give your opinion.

## Other PRs and issues related to this:

Add .gitattributes file (symfony/symfony#29277)
Added .gitattributes files to root and all components (symfony/symfony#26472)
Exclude non-essential files from Composer package (symfony/symfony#25414)
[HttpFoundation] optimize files for distribution (symfony/symfony#24427)
Add .gitattributes files (symfony/symfony#23926)
[Suggestion] Adding .gitattributes to ignore unnecessary folders and files for production env (symfony/symfony#20057)
Add lightweight and root only .gitattributes (symfony/symfony#18004)
Add .gitattributes to exclude tests from ZIPs (symfony/symfony#17995)
[RFC] Move tests out of the source and source out of the tests (symfony/symfony#17749)
Removal of development & testing files using .gitattributes (symfony/symfony#16174)
Please add .gitattributes files and fix line endings (symfony/symfony#13521)
making use of .gitattributes (symfony/symfony#11810)

## Workarounds

There are workarounds for both sides. Example:

### Workaround if merged

* `composer update --prefer-source`

### Workaround if closed

* `find vendor/symfony -name "Tests" -type d -exec rm -r "{}" \;`
* editorconfig/editorconfig#228
* https://github.com/dg/composer-cleaner

Commits
-------

ac7dc24bcb Adding .gitattributes to remove Tests directory from "dist"
symfony-splitter pushed a commit to symfony/cache that referenced this pull request Sep 16, 2019
…dist" (Nyholm)

This PR was merged into the 4.4 branch.

Discussion
----------

Adding .gitattributes to remove Tests directory from "dist"

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no?
| Tickets       |
| License       | MIT
| Doc PR        |

This is a controversial topic that have been mentioned before. We recently had some discussions on Slack about it and the community not in an agreement. This was asked back in 2014 already.

Im making this PR again, because I think this will help more people than it hurts to keep the tests in the "dist" version.

### Reasons for keeping the tests with the source

* You can look at the tests to understand how the code works
* It is convenient

In the past there were an argument of people might depend on Symfony's classes in Tests. That is no longer the case since we moved reusable classes from Tests to Test.

### Reasons for removing them (merging this PR)

* There should be difference between `composer update --prefer-source` and `composer update --prefer-dist`
* Smaller packages when deploying with Docker or on Serverless.
* Static analysis tools will not complain on PHP syntax errors in our tests ([example](https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/DependencyInjection/Tests/Fixtures/xml/xml_with_wrong_ext.php))

## How to decide?

Merging this PR or not is tricky because no side has a solid technical argument. It is basically just personal preference. Please give this PR a 👍 or 👎 if you want to give your opinion.

## Other PRs and issues related to this:

Add .gitattributes file (symfony/symfony#29277)
Added .gitattributes files to root and all components (symfony/symfony#26472)
Exclude non-essential files from Composer package (symfony/symfony#25414)
[HttpFoundation] optimize files for distribution (symfony/symfony#24427)
Add .gitattributes files (symfony/symfony#23926)
[Suggestion] Adding .gitattributes to ignore unnecessary folders and files for production env (symfony/symfony#20057)
Add lightweight and root only .gitattributes (symfony/symfony#18004)
Add .gitattributes to exclude tests from ZIPs (symfony/symfony#17995)
[RFC] Move tests out of the source and source out of the tests (symfony/symfony#17749)
Removal of development & testing files using .gitattributes (symfony/symfony#16174)
Please add .gitattributes files and fix line endings (symfony/symfony#13521)
making use of .gitattributes (symfony/symfony#11810)

## Workarounds

There are workarounds for both sides. Example:

### Workaround if merged

* `composer update --prefer-source`

### Workaround if closed

* `find vendor/symfony -name "Tests" -type d -exec rm -r "{}" \;`
* editorconfig/editorconfig#228
* https://github.com/dg/composer-cleaner

Commits
-------

ac7dc24bcb Adding .gitattributes to remove Tests directory from "dist"
symfony-splitter pushed a commit to symfony/yaml that referenced this pull request Sep 16, 2019
…dist" (Nyholm)

This PR was merged into the 4.4 branch.

Discussion
----------

Adding .gitattributes to remove Tests directory from "dist"

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no?
| Tickets       |
| License       | MIT
| Doc PR        |

This is a controversial topic that have been mentioned before. We recently had some discussions on Slack about it and the community not in an agreement. This was asked back in 2014 already.

Im making this PR again, because I think this will help more people than it hurts to keep the tests in the "dist" version.

### Reasons for keeping the tests with the source

* You can look at the tests to understand how the code works
* It is convenient

In the past there were an argument of people might depend on Symfony's classes in Tests. That is no longer the case since we moved reusable classes from Tests to Test.

### Reasons for removing them (merging this PR)

* There should be difference between `composer update --prefer-source` and `composer update --prefer-dist`
* Smaller packages when deploying with Docker or on Serverless.
* Static analysis tools will not complain on PHP syntax errors in our tests ([example](https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/DependencyInjection/Tests/Fixtures/xml/xml_with_wrong_ext.php))

## How to decide?

Merging this PR or not is tricky because no side has a solid technical argument. It is basically just personal preference. Please give this PR a 👍 or 👎 if you want to give your opinion.

## Other PRs and issues related to this:

Add .gitattributes file (symfony/symfony#29277)
Added .gitattributes files to root and all components (symfony/symfony#26472)
Exclude non-essential files from Composer package (symfony/symfony#25414)
[HttpFoundation] optimize files for distribution (symfony/symfony#24427)
Add .gitattributes files (symfony/symfony#23926)
[Suggestion] Adding .gitattributes to ignore unnecessary folders and files for production env (symfony/symfony#20057)
Add lightweight and root only .gitattributes (symfony/symfony#18004)
Add .gitattributes to exclude tests from ZIPs (symfony/symfony#17995)
[RFC] Move tests out of the source and source out of the tests (symfony/symfony#17749)
Removal of development & testing files using .gitattributes (symfony/symfony#16174)
Please add .gitattributes files and fix line endings (symfony/symfony#13521)
making use of .gitattributes (symfony/symfony#11810)

## Workarounds

There are workarounds for both sides. Example:

### Workaround if merged

* `composer update --prefer-source`

### Workaround if closed

* `find vendor/symfony -name "Tests" -type d -exec rm -r "{}" \;`
* editorconfig/editorconfig#228
* https://github.com/dg/composer-cleaner

Commits
-------

ac7dc24bcb Adding .gitattributes to remove Tests directory from "dist"
symfony-splitter pushed a commit to symfony/mailer that referenced this pull request Sep 28, 2021
…dist" (Nyholm)

This PR was merged into the 4.4 branch.

Discussion
----------

Adding .gitattributes to remove Tests directory from "dist"

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no?
| Tickets       |
| License       | MIT
| Doc PR        |

This is a controversial topic that have been mentioned before. We recently had some discussions on Slack about it and the community not in an agreement. This was asked back in 2014 already.

Im making this PR again, because I think this will help more people than it hurts to keep the tests in the "dist" version.

### Reasons for keeping the tests with the source

* You can look at the tests to understand how the code works
* It is convenient

In the past there were an argument of people might depend on Symfony's classes in Tests. That is no longer the case since we moved reusable classes from Tests to Test.

### Reasons for removing them (merging this PR)

* There should be difference between `composer update --prefer-source` and `composer update --prefer-dist`
* Smaller packages when deploying with Docker or on Serverless.
* Static analysis tools will not complain on PHP syntax errors in our tests ([example](https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/DependencyInjection/Tests/Fixtures/xml/xml_with_wrong_ext.php))

## How to decide?

Merging this PR or not is tricky because no side has a solid technical argument. It is basically just personal preference. Please give this PR a 👍 or 👎 if you want to give your opinion.

## Other PRs and issues related to this:

Add .gitattributes file (symfony/symfony#29277)
Added .gitattributes files to root and all components (symfony/symfony#26472)
Exclude non-essential files from Composer package (symfony/symfony#25414)
[HttpFoundation] optimize files for distribution (symfony/symfony#24427)
Add .gitattributes files (symfony/symfony#23926)
[Suggestion] Adding .gitattributes to ignore unnecessary folders and files for production env (symfony/symfony#20057)
Add lightweight and root only .gitattributes (symfony/symfony#18004)
Add .gitattributes to exclude tests from ZIPs (symfony/symfony#17995)
[RFC] Move tests out of the source and source out of the tests (symfony/symfony#17749)
Removal of development & testing files using .gitattributes (symfony/symfony#16174)
Please add .gitattributes files and fix line endings (symfony/symfony#13521)
making use of .gitattributes (symfony/symfony#11810)

## Workarounds

There are workarounds for both sides. Example:

### Workaround if merged

* `composer update --prefer-source`

### Workaround if closed

* `find vendor/symfony -name "Tests" -type d -exec rm -r "{}" \;`
* editorconfig/editorconfig#228
* https://github.com/dg/composer-cleaner

Commits
-------

ac7dc24bcb Adding .gitattributes to remove Tests directory from "dist"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants