identity.rs icon indicating copy to clipboard operation
identity.rs copied to clipboard

[Task] Find a new tool for license header checks

Open olivereanderson opened this issue 2 years ago • 2 comments

Description

The unstable license_template_path from rustfmt was removed in this PR. Since we rely on this option a replacement will have to be found.

@grtlr is working on cargo-license-template which is intended to provide comparable functionality, however it is not yet ready to be used for identity.rs as it currently errors on .rs files in the target directories of sub-projects (such as bindings/stronghold-nodejs). @grtlr is aware of this issue and will hopefully soon be able to solve it and we can of course also offer to help.

olivereanderson avatar Jun 23 '22 12:06 olivereanderson

I've just release version v0.1.3 which includes the functionality to ignore files via an --ignore flag and a .gitignore-like file:

cargo license-template --template .license_template --ignore .license_template_ignore --verbose

I will soon start to transition to tool to be independent from cargo and rather make it completely self-contained. The next step would be to offer a convenient GitHub Action that does not require building the tool from scratch every time we run CI.

grtlr avatar Jun 24 '22 08:06 grtlr

Fantastic. With v0.1.3 it suffices to add a .license_template_ignore file to ignore the libjose fixtures for now.

libjose/tests/fixtures/

Alternatively a change similar to #917 could be applied for the following files:

libjose/tests/fixtures/rfc7797.rs ... failed
libjose/tests/fixtures/rfc8037_ed25519.rs ... failed
libjose/tests/fixtures/rfc7518.rs ... failed
libjose/tests/fixtures/rfc7638.rs ... failed
libjose/tests/fixtures/rfc8037_x448.rs ... failed
libjose/tests/fixtures/rfc8037_x25519.rs ... failed
libjose/tests/fixtures/rfc7516.rs ... failed
libjose/tests/fixtures/rfc7517.rs ... failed
libjose/tests/fixtures/rfc7515.rs ... failed

Either way we should add cargo-license-template to GitHub Actions.

cycraig avatar Jul 05 '22 11:07 cycraig