-
Notifications
You must be signed in to change notification settings - Fork 61
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add automated license header checks #49
Comments
OpenSearch plugins' source code should include a valid SPDX license header (along with the existing license headers, if any). Further, plugins should enable the 'licenseHeaders' check in their build.gradle file if it was previously disabled. Plugin authors can also use IntelliJ's Copyright functionality to auto-generate this license header. This Copyright profile can be made a part of the plugin repo itself so that headers are consistently generated for all contributors. |
@ketanv3 any interest in picking this up, writing it up in this repo, and helping track it across plugins? |
@dblock Sure, please assign this to me. |
Update: Turns out that a few plugins prefer auto-generating the license headers using plugins like Spotless. Rather than imposing these plugins to use IntelliJ's Copyright feature, letting each plugin decide what's best for them. For now, simply enabling the license header checks for such plugins. Plugin checklist:
|
@ketanv3 thanks for taking care of this. You don't have to make changes in every plugin. Can you document the process on how to setup the license header checks in this repository and we can take @MMakaria's help to drive it across all the plugins to make sure all plugins will follow the steps you have recommended. |
@saratvemulapalli Sure! I'll raise a PR documenting this process. |
Closing this as documentation for setting up license headers is done. |
We have to standardize the way to develop on opensearch-project.
We should be able to have license header checks.
The text was updated successfully, but these errors were encountered: