valkyrjaio / sindri-ts / 30778531034

100%

push

github

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

# 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 154 files.

`EXCLUDED` names two groups beyond the documents and the configuration
files:

- `tests/Tests/Fixtures/*` — an AST input sample that a reader under
test parses as source. A
  header would become part of the source the test asserts on.
- `*.golden` — the output that the golden tests compare against. Sindri
generates each file, so a
header would have to come from the generator, and the generator writes
the file that an
  application consumes.

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 ... (continued)

990 of 990 branches covered (100.0%)

Branch coverage included in aggregate %.

1601 of 1601 relevant lines covered (100.0%)

24.09 hits per line