valkyrjaio / valkyrja-ts / 30778525416

100%

push

github

[Copyright] ci: Add the copyright header check (#163)

# Description

ESLint holds a TypeScript file to the copyright header through the local
`copyright-header` rule.
The rule runs over the source and the test trees only, so a build
configuration file outside them
has no mechanism that reads its header. A tool that selects a file by
extension also 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` 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 found no file that lacks the header. It verifies 866 files,
which is every TypeScript
file in the repository plus the new config file itself. Every other
tracked file is a document, a
configuration file, or a `.gitkeep` placeholder, and each one holds no
program code.

The check overlaps the ESLint rule on the files under `src` and `tests`,
and the overlap is
deliberate. It also reaches `.github/ci/**`, which the ESLint rule does
not.

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.

The job pins `6452916b1`, which is the
tip of `26.x` in
`valkyrjaio/.github`. The other reusable workflows in this file pin the
v26.21.0 commit. The check
needs the newer commit, because v26.21.0 gave the block comment form to
a PHP file only, and this
repository holds files that write the header between `/*` and `*/`. The
ref update job aligns every
pin at the next release.

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

## Types of changes

- [x] Improvement _(non-breaking c... (continued)

1735 of 1735 branches covered (100.0%)

Branch coverage included in aggregate %.

3765 of 3765 relevant lines covered (100.0%)

28.9 hits per line