Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion .github/workflows/deploy-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ on:
- main
paths:
- src/**
- tests/**
- 'tools/coverage-badge.php'
- 'phpdoc.xml'
- 'bin/generate-docs.sh'
- 'tools/docs-check.php'
Expand Down Expand Up @@ -36,14 +38,22 @@ jobs:
with:
php-version: '8.3'
extensions: dom, mbstring
coverage: none
coverage: xdebug

- name: Install dependencies
run: composer install --no-interaction --no-progress --prefer-dist --ignore-platform-reqs

- name: Run coverage for badge
env:
XDEBUG_MODE: coverage
run: composer test:coverage

- name: Build API documentation
run: composer docs

- name: Coverage badge endpoint
run: php tools/coverage-badge.php var/coverage/clover.xml docs/coverage.json

- name: Setup Pages
uses: actions/configure-pages@v5

Expand Down
61 changes: 61 additions & 0 deletions tools/coverage-badge.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
#!/usr/bin/env php
<?php

declare(strict_types=1);

/**
* Генерирует shields.io-endpoint JSON с фактическим покрытием строк
* из clover-отчёта. Публикуется на GitHub Pages рядом с документацией —
* бейдж в README живёт без внешних сервисов и токенов.
*
* Использование: php tools/coverage-badge.php [clover.xml] [выход.json]
*/

$cloverPath = $argv[1] ?? 'var/coverage/clover.xml';
$outputPath = $argv[2] ?? 'docs/coverage.json';

if (!is_file($cloverPath)) {
fwrite(STDERR, sprintf('Нет clover-отчёта: %s%s', $cloverPath, PHP_EOL));

exit(1);
}

$xml = simplexml_load_file($cloverPath);

if ($xml === false || $xml->project->metrics === null) {
fwrite(STDERR, 'Не удалось разобрать clover.xml.' . PHP_EOL);

exit(1);
}

$metrics = $xml->project->metrics;
$statements = (int)$metrics['statements'];
$covered = (int)$metrics['coveredstatements'];

if ($statements === 0) {
fwrite(STDERR, 'В отчёте нет исполняемых строк.' . PHP_EOL);

exit(1);
}

$percent = round($covered / $statements * 100, 2);
$color = $percent >= 98.0 ? 'brightgreen' : ($percent >= 90.0 ? 'yellow' : 'red');

$badge = [
'schemaVersion' => 1,
'label' => 'coverage',
'message' => rtrim(rtrim(number_format($percent, 2, '.', ''), '0'), '.') . '%',
'color' => $color,
];

$dir = \dirname($outputPath);

if (!is_dir($dir) && !mkdir($dir, 0775, true) && !is_dir($dir)) {
fwrite(STDERR, sprintf('Не удалось создать каталог %s%s', $dir, PHP_EOL));

exit(1);
}

file_put_contents($outputPath, json_encode($badge, JSON_THROW_ON_ERROR) . PHP_EOL);
printf("Бейдж покрытия: %s → %s%s", $badge['message'], $outputPath, PHP_EOL);
exit(0);
Loading