fix(server): unify the license headers#2438
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2438 +/- ##
============================================
- Coverage 66.23% 61.39% -4.84%
+ Complexity 828 488 -340
============================================
Files 511 511
Lines 42597 42598 +1
Branches 5942 5942
============================================
- Hits 28215 26154 -2061
- Misses 11566 13759 +2193
+ Partials 2816 2685 -131 ☔ View full report in Codecov by Sentry. |
This PR solely updates the license header in |
Get it, license header could update together (due to it is almost a completely repetitive task, just take a few samples for inspection and confirmation, no need to check them one by one) |
|
@msgui I noticed that some configuration files, such as |
thanks for the reminder |
|
this commit includes files of all formats for easy review. |
|
Also, these extra blank lines here can be removed, it seems? |
ec696fc to
3321852
Compare
Thank you for the reminder. The license header format in the remaining files is already correct, so no further corrections are needed |
VGalaxies
left a comment
There was a problem hiding this comment.
Great work! I have performed verification locally following the steps in Project Migration/Package Name Change + IDEA Configuration Instructions (Complete Version), and it meets expectations.
@msgui Consider supplementing the detailed steps for updating copyright to the above document, explaining how to configure IDEA from scratch and how to update copyright with a single click (Because I encountered some unclear points during the configuration process, such as how to match the files that need updating, the relevant content in the above document is somewhat scattered. It might be beneficial to consolidate it together)
|
@imbajin could also check again~ Additionally, I believe that performing the license header check in the current CI (licence-checker.yml) seems somewhat delayed. It might be worth considering moving it to the verify stage. This way, developers can discover related errors earlier during local builds. |
Good suggestion, could mark it as a TODO (enhance our CI to check/validate style problems) |
|
This tool hawkeye may help license header check and format? |
There was a problem hiding this comment.
TODOs:
- keep the LICENSE header from refer code (revert/exclude it by reg?)
- rearrange the commit range
- keep the
dist/*/bin/*.properties(user config files) clean (no need to add header here) - remove the header in
org.apache.tinkerpop.gremlin.server.OpProcessororGremlinPlugin(pure text file)
There was a problem hiding this comment.
It seems that some files license headers are inconsistent with those in https://github.com/apache/incubator-hugegraph/wiki/HugeGraph-Code-Style-Guide.
TODOs:
- keep the LICENSE header from refer code (revert/exclude it by reg?)
- rearrange the commit range
- keep the
dist/*/bin/*.properties(user config files) clean (no need to add header here)- remove the header in
org.apache.tinkerpop.gremlin.server.OpProcessororGremlinPlugin(pure text file)
Also, do the TODOs here need to be addressed in this PR? @imbajin
imbajin
left a comment
There was a problem hiding this comment.
Almost have checked all the files already (Also finished all the TODOS now)
subtask of #2435 --------- Co-authored-by: imbajin <jin@apache.org> Co-authored-by: VGalaxies <vgalaxies@apache.org>
This reverts commit 7586779.
@imbajin Is it only for cleaning the license header in properties files in user configuration files here? I found that some other user configuration files have license headers. Also, do properties files in the |
@VGalaxies
So these places seem to fit the 1st & 3rd points and can preserve license headers. |










Purpose of the PR
Main Changes
Verifying these changes
Does this PR potentially affect the following parts?
Documentation Status
Doc - TODODoc - DoneDoc - No Need