aws
Copyright linter misses rust files, python files, etc.
Problem:
The copyright linter skips over files not explicitly allowlisted in codebuild/bin/copyright_mistake_scanner.sh, including .rs files which comprise most of bindings/rust, .c/.h files not starting with s2n_ like those in bin/, etc.
Solution:
Add all files with .c, .h, .rs, .py, .cc, .sh, etc. extensions to the allowlist in the copyright linter. Alternatively, use a denylist instead in case more file types are added in the future.
- Does this change what S2N sends over the wire? no
- Does this change any public APIs? no
- Which versions of TLS will this impact? n/a
Requirements / Acceptance Criteria:
Files without a copyright header that need one should not pass CI.
- RFC links: none
- Related Issues: none
- Will the Usage Guide or other documentation need to be updated? no
-
Testing: Possibly run script with files without copyright headers and make sure it fails?
- Will this change trigger SAW changes? no
- Should this change be fuzz tested? no
Out of scope:
None
If I understand the linter correctly, it is then also not checking the .ymls in codebuild/spec/, which also needs amending. Correct?
Or does the linter only focus on certain directories on not others (which I highly doubt, as the previous and current proposed solution is to allow/deny certain file extensions generally, regardless of their directories).
Yep, our copyright linter isn't that sophisticated so it currently misses our yaml files.
Another option for a linter, GHA https://github.com/todogroup/repolinter/blob/main/docs/rules.md#file-starts-with
