Add license header
org.openrewrite.java.AddLicenseHeader
Adds license headers to Java source files when missing. Does not override existing license headers.
- groupId: org.openrewrite
- artifactId: rewrite-java
- version: 7.40.6
Type | Name | Description |
|---|---|---|
String | licenseText | The license header text without the block comment. May contain ${CURRENT_YEAR} property. |
This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your
rewrite.yml create a new recipe with a unique name. For example: com.yourorg.AddLicenseHeaderExample. Here's how you can define and customize such a recipe within your rewrite.yml:rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddLicenseHeaderExample
displayName: Add license header example
recipeList:
- org.openrewrite.java.AddLicenseHeader:
licenseText: Copyright ${CURRENT_YEAR} the original author or authors...
Now that
com.yourorg.AddLicenseHeaderExample has been defined activate it in your build file:Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.40.4")
}
rewrite {
activeRecipe("com.yourorg.AddLicenseHeaderExample")
}
repositories {
mavenCentral()
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.45.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.AddLicenseHeaderExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.
Last modified 22d ago