marquez icon indicating copy to clipboard operation
marquez copied to clipboard

[Docs] Add Github workflow to check for header in source code

Open merobi-hub opened this issue 2 years ago • 1 comments

Signed-off-by: Michael Robinson [email protected]

Problem

The project lacks an automated way to check new source files for a copyright and license header.

Solution

This change adds a Github workflow to check changed and added source code for a header. A new yaml file, headerchecker.yml, can be found in the .github directory. New file types can be easily added in the Bash script there. Currently the workflow is only checking Java files.

Checklist

  • [x] You've signed-off your work
  • [ ] Your changes are accompanied by tests (if relevant)
  • [x] Your change contains a small diff and is self-contained
  • [ ] You've updated any relevant documentation (if relevant)
  • [ ] You've updated the CHANGELOG.md with details about your change under the "Unreleased" section (if relevant, depending on the change, this may not be necessary)
  • [ ] You've versioned your .sql database schema migration according to Flyway's naming convention (if relevant)
  • [ ] You've included a header in any source code files (if relevant)

merobi-hub avatar Sep 19 '22 21:09 merobi-hub

Codecov Report

Merging #2128 (a45cec8) into main (e61fe48) will not change coverage. The diff coverage is n/a.

:exclamation: Current head a45cec8 differs from pull request most recent head e616928. Consider uploading reports for the commit e616928 to get more accurate results

@@            Coverage Diff            @@
##               main    #2128   +/-   ##
=========================================
  Coverage     75.30%   75.30%           
  Complexity     1038     1038           
=========================================
  Files           203      203           
  Lines          4883     4883           
  Branches        399      399           
=========================================
  Hits           3677     3677           
  Misses          763      763           
  Partials        443      443           

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

codecov[bot] avatar Sep 20 '22 14:09 codecov[bot]