DevInstructions.md

Maintenance

Updating copyright year range

1. update currentYear in the every pom.xml as the first thing every year
   • yes, this is annoying, we should refactor the project to have actual module inheritance
2. run mvn -P license license:format -DskipITs for the root module to update the year range in all the Java files of all the modules
   • based on each module's src/license/header.txt and currentYear
   • root module doesn't have its own header.txt so it uses vaadin-spreadsheet/src/license/header.txt
3. check that all modules got updated .java files with the correct year
   • update the inclusion list for com.mycila.license-maven-plugin in that module's pom.xml if needed

Updating license name

Java class license headers:

1. update contents of license tags in vaadin-spreadsheet/pom.xml
2. update the files header.txt and license.txt in all vaadin-spreadsheet/src/license/, vaadin-spreadsheet-charts/src/license/, and vaadin-spreadsheet-testbench-api/src/license/
   • triplicated because all jars need to contain the files
3. run mvn -P license license:format -DskipITs for the root module to update the license information and the year range in all the Java files of all the modules
4. check that all modules got updated .java files with the correct year

Other places where the licensing information should be updated:

1. README.md
2. LICENSE.txt
3. AdVaaLicen tag for org.apache.maven.plugins.maven-jar-plugin in vaadin-spreadsheet/pom.xml
4. Vaadin Spreadsheet documentation for Vaadin 8 and Vaadin 7, search the category for license
5. general add-on licensing documentation (V8 and V7)

Removal should be considered, but update while they still exist:

1. license.html and README.txt in directory/assembly/
2. the various documentation/*.asciidoc pages, search for license

License name update instructions should also be used if the decision is made to include the license version number again.