Add license header

org.openrewrite.java.AddLicenseHeader
Adds license headers to Java source files when missing. Does not override existing license headers.
Source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-java
version: 8.6.0
Options
Type
Name
Description
String
licenseText
The license header text without the block comment. May contain ${CURRENT_YEAR} property.
Usage
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
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.3.11")
}
​
rewrite {
    activeRecipe("com.yourorg.AddLicenseHeaderExample")
}
​
repositories {
    mavenCentral()
}
2.Run gradle rewriteRun to run the recipe.
1.Add the following to your pom.xml file:
pom.xml
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.5.2</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.AddLicenseHeaderExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
Contributors
​Jonathan Schneider​
​Sam Snyder​
​Aaron Gershman​
See how this recipe works across multiple open-source repositories
​​
​​
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.

Type	Name	Description
`String`	licenseText	The license header text without the block comment. May contain ${CURRENT_YEAR} property.

Add imports for fully qualified references to types

Add or update annotation attribute

Last modified 5d ago