Skip to content
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

[DOCS] Extend PHIVE section in docs #1388

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kanow
Copy link
Collaborator

@kanow kanow commented Jul 29, 2024

Fixes #543
Fixes #429

@kanow kanow requested a review from oliverklee July 29, 2024 17:26
@kanow kanow force-pushed the 543-addphive-section-to-docs branch from 8808a1b to 8d22277 Compare July 29, 2024 17:27
@coveralls
Copy link

coveralls commented Jul 29, 2024

Pull Request Test Coverage Report for Build 10148954928

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 10148857135: 0.0%
Covered Lines: 46
Relevant Lines: 46

💛 - Coveralls

@oliverklee oliverklee added the documentation Improvements or additions to documentation label Jul 30, 2024
To support php version 7.4 and 8.2 in the `tea` extension, we are using PHIVE
to install `phpunit/phpcov`.
We need `phpunit/phpcov` in version 10 to support php 8.2.
Our minimum php version 7.4 would prevent the installation with composer.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd suggest to explain this in more detail to explain the problem, e.g., with this wording:

To keep things simple, we try do model as many dependencies as possible as Composer dependencies in the composer.json`. However, sometime a dependency is not available for all PHP versions that we support, or it might conflict with another dependency. One of this cases is PHPCOV, a library we use to collect and transmit code coverage information: The version that works with PHP 8.2 and 8.3 does not work with PHP 7.3. So we have switch this particular dependency from being installed via Composer to being installed via PHIVE.

Copy link
Contributor

Choose a reason for hiding this comment

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

We could also add this explanation:

As we usually only collect code coverage data on CI and not locally, it's usually not necessary to install PHPDOV locally.

@oliverklee
Copy link
Contributor

@kanow Let's get this PR finished and merged! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

Add a small section to the docs with the PHIVE usage essentials Document why we're using phpcov via PHIVE
3 participants