Investigate/Add skywalking-eyes license header check to project

[andrewtavis]

Terms

• I have searched open and closed feature requests
• I agree to follow activist's Code of Conduct

Description

In the most recent dev sync we discussed how to make sure that we have SPDA license identifiers at the top of all files. The best way to do this seems to be to use skywalking-eyes from Apache. This issue would be to add in a new workflow to run on PRs to run this GitHub action via the following snippet:

- name: Check License Header
  uses: apache/skywalking-eyes/header@main  

Let's also discuss include the check dependency license functionality :)

Contribution

Happy to work with someone on this and review when there's a PR 😊

[hboppana]

Hey, this issue would be my first open source contribution on Github. Would be happy to resolve it if help is needed!

[andrewtavis]

We'd be happy to work with you on this, @hboppana! Please let us know if you have any questions :)

[Abhi-Bohora]

Hello, @andrewtavis I have decided to take a look into this since it's been more than a week @hboppana might be busy. I wanted to ask a question. Is this .licenserc.yaml would be enough or am I missing something ? I have tested this locally, It worked fine except one file that didn't have license as you can see in the screenshot. Thanks 🙏

.licenserc.yaml

 header:
  license:
    content: "SPDX-License-Identifier: AGPL-3.0-or-later"
  paths:
    - '**/*.vue'
    - '**/*.ts'
    - '**/*.test.ts'
    - '**/*.d.ts'
    - '**/*.py'
  paths-ignore:
    - 'dist'
    - 'node_modules'
    - '**/*.md'
    - 'LICENSE'
    - 'NOTICE'
    - '**/__pycache__/**'
    - '**/.git/**'
    - '**/*__init__.py'
  comment: on-failure
  license-location-threshold: 10

[andrewtavis]

Is looking good to me, @Abhi-Bohora! @hboppana, hope it's ok if we let @Abhi-Bohora work on this and then we can find another issue for you? The i18n-map file is something we'd need to figure out as that's a generated file, but for now I can edit the function and have it be included :) Feel free to send this along and I'll do that edit 😊

[hboppana]

Sorry about that @andrewtavis. I needed approval from my university to even work on open-source and couldn't get it till yesterday. If you could find another issue for me that would be great!

[andrewtavis]

Closed by #1114 🚀 Thanks for the great work here, @Abhi-Bohora, and appreciate your willingness to pass the issue on, @hboppana :) Sorry it took so long to get approval. There are still many good first issues. Maybe you could look into #1097? Let me know if something looks interesting!

[hboppana]

For sure @andrewtavis . I can look into #1097 if you need me to!

[andrewtavis]

#1099 might also be a good one to check out, if either of you had interest in it :)