valkyrjaio / valkyrja-java / 30778877195

100%

push

github

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

# Description

Spotless holds every Java file to the copyright header, and it targets
`**/*.java` only. A Gradle
Kotlin script, a shell entry point, and a file of any other type have no
mechanism that reads the
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` v26.22.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 found no file that lacks the header. It verifies 1207 files:
every Java file, every
Gradle Kotlin script, and the new config file itself. The 12
`*.gradle.kts` files are the ones no
tool read before, because Spotless targets `**/*.java` only.

The check overlaps Spotless on the Java files, and the overlap is
deliberate. A negative control
confirms the check reads the text rather than passing vacuously: with a
deliberately wrong
`IDENTIFIER`, it reports all 1207 files.

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 the v26.22.0 commit. The other reusable workflows in this
file pin v26.21.0. This
check needs the newer release, because v26.21.0 gave the block comment
form to a PHP file only, and
this repository holds Java and Kotlin files, which 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 change which improves code)_
- [ ] Bug fix _(non-breakin... (continued)

1929 of 1929 branches covered (100.0%)

Branch coverage included in aggregate %.

7070 of 7070 relevant lines covered (100.0%)

4.33 hits per line