QuIC Repolinter errors

[mynameistechno]

@quic-rneti the check is currently failing. We should correct the violations and/or tweak the config for this particular repo. See the"Repolinter Output" section that is in Error here https://github.com/quic/qidk/actions/runs/9639387487/job/26581482294

For example the ✖ source-license-headers-exist section is complaining about a lot of source files missing the quic copyright and license header. Can you confirm if QuIC authored all those files? E.g. in the Examples and Solutions directories? If so, we should add the copyright/license headers to those. If they are third party, we should then add an exception to the repolinter config. I can help with this, but here are some instructions

https://github.com/quic/.github?tab=readme-ov-file#customizing-repolinter-rules

[mynameistechno]

It looks like the last run is still failing (expand the "Repolinter output" section to see errors about binary files and source files missing the QuIC copyright/license header): https://github.com/quic/qidk/actions/runs/11051235272/job/30700684960

What are these binaries and are they necessary to be in the repo? https://github.com/quic/qidk/tree/master/Solutions/NLPSolution3-AutomaticSpeechRecognition-Whisper/Android_App_Whisper/app/src/main/jniLibs/arm64-v8a

Are these files all QC-authored? If so, we should add the copyright header. If not we need to exclude paths from repolinter's checks:

https://github.com/quic/.github?tab=readme-ov-file#customizing-repolinter-rules

[mynameistechno]

The last commit has the failed status run details (the red X). When Repolinter is running without error it'll be a green check. We should only merge PRs when all the checks are passing so the repo is not in a "failed state"

[quic-vraidu]

I think Repolinter is not running properly. Copyright details are present for those files.

[quic-vraidu]

@mynameistechno, Most of the header files and java files contains the copyright details. Please check why Repolinter script is reporting the issue.

[mynameistechno]

@mynameistechno, Most of the header files and java files contains the copyright details. Please check why Repolinter script is reporting the issue.

The first one I checked doesn't have it:

https://github.com/quic/qidk/blob/master/Solutions/NLPSolution1-QuestionAnswering/scripts/batch_tf_inf.py

What are these binaries and are they necessary to be in the repo? https://github.com/quic/qidk/tree/master/Solutions/NLPSolution3-AutomaticSpeechRecognition-Whisper/Android_App_Whisper/app/src/main/jniLibs/arm64-v8a

Also what about the binaries? Typically binaries should not be included in a git repo, but in some cases it's valid but we need to alert Repolinter to skip them.

[quic-vraidu]

@mynameistechno, Yes, Repolinter reports both valid and invalid files. Can you please solve the issue because even though we correct the invalid files, Repolinter still reports issue for valid files.

Is it possible validate Repolinter offline before upload to changes to github.

Binaries, I will check and correct them accordingly.

[mynameistechno]

@mynameistechno, Yes, Repolinter reports both valid and invalid files. Can you please solve the issue because even though we correct the invalid files, Repolinter still reports issue for valid files.

@quic-vraidu what do you mean? Please share a file that Repolinter reports as invalid that is valid. This file clearly is missing the QuIC copyright and license:

https://github.com/quic/qidk/blob/master/Solutions/NLPSolution1-QuestionAnswering/scripts/batch_tf_inf.py

That is just one of the files. See the repolinter output at https://github.com/quic/qidk/actions/runs/11164227762/job/31033040264#step:6:471

for all the violations.

Is it possible validate Repolinter offline before upload to changes to github.

Yes it's possible. You can run it locally, but it also runs when a Pull Request is opened. Your team should be following the GitHub model where changes are proposed as PRs instead of git pushing directly. Repolinter will run as GitHub Action when a PR is opened. Someone reviews the code and automated checks like unit tests and Repolinter can run prior to merging. See AIMET example: https://github.com/quic/aimet/pull/3352

You can also run repolinter locally. E.g. with docker for the code in the current directory:

docker pull ghcr.io/todogroup/repolinter:v0.11.1
docker run -t -v $PWD:/src -w /src ghcr.io/todogroup/repolinter:v0.11.1 --rulesetUrl https://raw.githubusercontent.com/quic/.github/main/repolint.json

[quic-vraidu]

@mynameistechno , Repolinter is report error on copyrighted files as well. Refer below files. Can you please solve the issue because even though we correct the invalid files, Repolinter still reports issue for valid files.

I just pointed 3 files. Lot of files have copyright but Repolinter still points as error. https://github.com/quic/qidk/blob/master/QHCI/hvx_cv/src/base/dsp/qhci_imp.c https://github.com/quic/qidk/blob/master/QHCI/hvx_cv/src/div16/dsp/div16_imp.c https://github.com/quic/qidk/blob/master/QHCI/hvx_cv/src/dummy/dsp/dummy_imp.c