valkyrjaio / valkyrja-starter-app-php / 30772734814
100%

DEFAULT BRANCH: 26.x
Ran
Jobs 1
Files 33
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 100.0%. Remained the same
30772734814

push

github

web-flow 
[Copyright] ci: Add the copyright header check (#234)

# Description

PHP CS Fixer holds every PHP file in this repository to the copyright
header, and it reads only
PHP. This repository also holds views, assets, an Apache configuration
file, and two PHP entry
points without an extension. A tool that selects a file by extension
goes green on a file type
nobody taught it about, so a gap does not report itself.

This pull request adds the shared copyright header check that
`valkyrjaio/.github` v26.21.0
released. The check is closed by default. It reads every tracked file,
and it requires the header
in each file that `EXCLUDED` does not match. A new file therefore fails
the check until a person
adds the header, or adds the file to `EXCLUDED`.

The check verifies 94 files. It reported the nine `*.example.php` stubs
on the first run. Each one
already carries the correct header. Each one also holds `//
phpcs:ignoreFile` between the PHP open
tag and `declare(strict_types=1);`, and the check does not read past
that line. The check skips the
open tag, the strict-types declaration, and an empty line, and it then
requires the header. Any
other line ends the skip, so the check read the directive where it
expected the header.

The first commit moves the directive below the header in each stub. PHP
CS Fixer places the header
directly after `declare(strict_types=1);`, and the directive now follows
the header instead of
preceding it. PHP_CodeSniffer reads `phpcs:ignoreFile` anywhere in the
file, so the directive keeps
its effect. `composer phpcodesniffer` passes on the change.

The second commit adds the config and the job.

The job runs on a pull request only, and it stands outside the
`source-paths` filter that the
`tools` job derives. A filter that misses a path skips the job, and a
skipped job reads the same as
a clean run.

`valkyrjaio/valkyrja-php#1123` is the reference consumer, and this pull
request copies its shape.

## Types of changes

- [x] Improvement _(... (continued)

517 of 517 relevant lines covered (100.0%)

2.12 hits per line

Jobs
ID Job ID Ran Files Coverage
1 30772734814.1 33
100.0
 GitHub Action Run
Source Files on build 30772734814