pre-commit auto add license headers for all Markdown files #11870
+468
−6
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a hook to auto add license header to Markdown files with pre-commit or on git commit.
Used on other Apache projects like Airflow and Sedona.
Example:
https://github.com/apache/airflow/blob/a2ee0d80d693890216694a571b11384c056fceb7/.pre-commit-config.yaml#L50
So this can be expanded to add license headers to other files types in future.
So this is more advanced than just checking for missing licenses with the pom.xml rat license plugin. If no license is found it auto inserts the header. On the GitHub CI it just works with pass or fail.
Types of changes
Feature/Enhancement Scale or Bug Severity
Feature/Enhancement Scale
Bug Severity
Screenshots (if appropriate):
How Has This Been Tested?
With pre-commit locally both before and after the license headers were auto added
How did you try to break this feature and the system with this change?