Auto-detect Github Actions CI and activate github logger accordingly

[mfn]

This PR:

• Adds new feature
• Covered by tests
• Doc PR: The Github Actions logger is now automatically detected site#231

Fixes #1560

---

With this PR, the --logger-github flag is not necessary when running in Github Actions anymore. It's still supported:

• doesn't break existing scripts
• can be used to force-enable this particular logger in non-Github Action environments if desired

When running on Github Actions, however, it's not possible to "disable" this logger; as long as the Github Actions CI is correctly detected according to OndraM/ci-detector, it will always be active. This is deliberately done to improve the out of the box experience with infection.

[maks-rafalko]

👍

[maks-rafalko]

Build failure

The minimum required MSI percentage should be 71.87%, but actual is 71.86%. Improve your tests!

it's not your fault, but comes from master. You can however change this line https://github.com/infection/infection/blob/master/.github/workflows/mt.yaml#L14 and update it to 71.86 so builds will pass.

Anyway, I'm happy to merge, please update the docs.

[mfn]

Thanks! I've pushed three more changes:

• mention the auto-detect also on the cli help itself
• lower the msi as suggested
• "eat our own dogfood" and remove the flag from the workflow itself
• further: docs PR at The Github Actions logger is now automatically detected site#231

[maks-rafalko]

looks like our end-to-end tests are broken now (https://github.com/infection/infection/runs/4787795564?check_suite_focus=true#step:12:5)

I suspect this is because tests, executed from PHPUnit, started producing GitHub warning messages (https://github.com/infection/infection/runs/4787795564?check_suite_focus=true#step:12:27) and this wasn't exptected from PHPUnit context

I have a feeling that we need to disable github logger here. Since it's being enabled automatically, probably we need to make it possible to pass --logger-github=false here:

infection/tests/phpunit/Console/E2ETest.php

Line 351 in 07490ad

'--no-interaction',

so the logic would be:

• GHA context, no options - automatically enabled
• GHA context, --logger-github=false - disabled
• GHA context, --logger-github - enabled
• non-GHA context, no options - disabled
• non-GHA context, --logger-github=false - disabled
• non-GHA context, --logger-github - enabled

what do you think?

Let me know if you need any help, since e2e tests can be not very clear.

[mfn]

@maks-rafalko what a gotcha 😅

I've pushed a commit to support --logger-github=false, from the commit

TL;DR:

• not provided: auto-detected
• --logger-github : enabled
• --logger-github=true : enabled
• --logger-github=false : disabled

I hope this is what you had in mind; I had to change it to nullable etc.

Though I've to trouble to figure out where to explicitly put --logger-github=false; somewhere in .github/workflows/ci.yaml I presume?

[localheinz]

Suggested change

	private function detectCiGithubActions(): bool
	{
	try {
	$ci = $this->ciDetector->detect();
	if ($ci->getCiName() === CiDetector::CI_GITHUB_ACTIONS) {
	return true;
	}
	} catch (CiNotDetectedException $e) {
	// deliberately empty
	}
	return false;
	}
	private function detectCiGithubActions(): bool
	{
	try {
	$ci = $this->ciDetector->detect();
	} catch (CiNotDetectedException $e) {
	return false;
	}
	if ($ci->getCiName() !== CiDetector::CI_GITHUB_ACTIONS) {
	return false;
	}
	return true;
	}

[maks-rafalko]

✔️

[localheinz]

Suggested change

	throw new InvalidArgumentException(
	sprintf('Cannot pass "%s" to "--%s": only "true", "false" or no argument is supported', $useGitHubLogger, self::OPTION_LOGGER_GITHUB)
	);
	throw new InvalidArgumentException(sprintf(
	'Cannot pass "%s" to "--%s": only "true", "false" or no argument is supported',
	$useGitHubLogger,
	self::OPTION_LOGGER_GITHUB
	));

[maks-rafalko]

✔️

[maks-rafalko]

@mfn could you please rebase?

[mfn]

@mfn could you please rebase?

Done and force-pushed!

[maks-rafalko]

I've rebased and fixed e2e tests.

Thanks for this feature @mfn!

[mfn]

Thank you for your time too 🙏🏼

[maks-rafalko]

Released: https://github.com/infection/infection/releases/tag/0.26.11