Add automatic copyright notice verification

[maltekliemann]

This didn't turn out as good as I wanted it to and currently has a couple of limitations (see below). How to use this currently:

• Install scripts/check-license by running pip install scripts/check-license and pip install -r scripts/check-license/requirements.txt.
• You have to specify all files that you want to check. The workflow does this automatically for all *.rs files using https://github.com/Ana06/get-changed-files. This is a fork of https://github.com/jitterbit/get-changed-files which solves this issue and allows us to filter files by their extension: The head commit for this pull_request event is not ahead of the base commit jitterbit/get-changed-files#11. This won't work if any of our files have a whitespace in their name. So... one more reason not to do that, I guess.
• Run check-license [files]. You can also run check-license -w [files] to write the missing copyright notices.

Current limitations:

• We don't check for the presence of the GPL license. This can easily be implemented by checking if the File object's blob starts with the proper string. It might be helpful to remove the leading "// ".
• Different file types can be handled by extending the File class a little bit. We may want to do that in the future.
• The checker doesn't dig deep into the git log to verify if old copyrights are correct. Can be done, but totally not within the scope of this PR.

You can see the workflow fail due to a missing copyright in a Rust file here: https://github.com/zeitgeistpm/zeitgeist/actions/runs/4085940425/jobs/7044586744.

Blocked by #964, which needs to be merged before merging this PR to ensure that we're starting off with a correct state. Closes #925.

[codecov-commenter]

Codecov Report

Merging #963 (72dc01a) into main (45edad6) will not change coverage.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##             main     #963   +/-   ##
=======================================
  Coverage   94.39%   94.39%           
=======================================
  Files          93       93           
  Lines       21060    21060           
=======================================
  Hits        19880    19880           
  Misses       1180     1180           

Flag	Coverage Δ
tests	94.39% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
zrml/court/src/lib.rs	87.41% <0.00%> (ø)
zrml/swaps/src/lib.rs	95.76% <0.00%> (ø)
zrml/court/src/mock.rs	33.33% <0.00%> (ø)
zrml/swaps/src/mock.rs	30.90% <0.00%> (ø)
primitives/src/asset.rs	41.17% <0.00%> (ø)
primitives/src/types.rs	3.12% <0.00%> (ø)
zrml/court/src/tests.rs	99.20% <0.00%> (ø)
zrml/swaps/src/tests.rs	99.96% <0.00%> (ø)
zrml/swaps/src/utils.rs	98.03% <0.00%> (ø)
primitives/src/market.rs	71.42% <0.00%> (ø)
... and 41 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[sea212]

This is a partial review, I'll do the rest soon.

[sea212]

The script does offer the option to correct those errors, what's your position to automatically adding a commit with the updated license headers and optionally passing the workflow log in a comment in the PR?

• Add a commit: https://github.com/zeitgeistpm/zeitgeist/actions/runs/985953773/workflow#L138-L147
• Comment success/failure + logs: https://github.com/zeitgeistpm/zeitgeist/actions/runs/985953773/workflow#L173-L189

[sea212]

Writing would just trigger in the case of a PR that should be merged into main.

[maltekliemann]

And the commit is triggered by placing a label?

[maltekliemann]

I'm okay with automating the process, but I have to caution everyone to double-check the diff everytime they do this. And just to prove my point, I botched the test for the File.write function because I forgot how mock works...

[maltekliemann]

Maybe just a quick argument against automating the write: It probably takes just as much time to execute the write locally and then push the changes manually as it takes to trigger the write remotely, but its much safer to make the changes locally and run git diff once just to check if there's been a mistake.

[sea212]

I see the point of adding the .gitignore in that folder and I think its sufficient for almost any case. However, maybe someone decides to initialize a pyenv within the root to cover anything from the root which will create a .python-version file in the root which is tracked by git. I think it would be better if we include either those rules in the repositories root .gitignore.

[maltekliemann]

28e8f70

[sea212]

Didn't expect such a complex solution, beware copyright notices 😄