Updated headers and license information. (#642)

Switched to use com.mycila.license-maven-plugin for the updating. Appended DevInstructions.md with usage instructions.
vaadin · Aug 30, 2023 · e6dd915 · e6dd915
1 parent a301f6e
commit e6dd915
Show file tree

Hide file tree

Showing 695 changed files with 7,659 additions and 5,268 deletions.
diff --git a/DevInstructions.md b/DevInstructions.md
@@ -142,4 +142,33 @@ EGit:
 1. right-click project > *Team* > *Remote* > *Configure Push To Upstream...*
     *-* Push URIs: <code> ssh://<i>yourusername</i>@dev.vaadin.com:29418/charts.git </code>
     *-* Ref mappings: <code> HEAD:refs/for/master </code>
-1. right-click project > *Team* > *Push to Upstream*
+1. right-click project > *Team* > *Push to Upstream*
+
+Maintenance
+=====
+
+Updating copyright year range
+-----
+1. update <code>currentYear</code> in the parent module's <code>pom.xml</code> as the first thing every year
+1. run <code>license:format</code> for the parent module to update the year range in all the Java files of all the modules (based on <code>addon/src/license/header.txt</code> and <code>currentYear</code>)
+1. check that only <code>.java</code> files got updated and update the exclusion list for <code>com.mycila.license-maven-plugin</code> in the parent module's <code>pom.xml</code> if needed
+1. update the header of <code>addon/src/main/resources/com/vaadin/addon/charts/Widgetset.gwt.xml</code> manually (the plugin is configured to ignore all <code>.xml</code> files)
+
+Updating license name or version
+-----
+Java class license headers:
+1. update the files <code>header.txt</code> and <code>license.txt</code> in both <code>addon/src/license/</code> and <code>compatibility-addon/src/license/</code> (duplicated because both jars need to contain the files)
+1. run <code>license:format</code> for the parent module to update the license information and the year range in all the Java files of all the modules (based on <code>addon/src/license/header.txt</code> and <code>currentYear</code> in the parent module's <code>pom.xml</code>)
+1. check that only <code>.java</code> files got updated and update the exclusion list for <code>com.mycila.license-maven-plugin</code> in the parent module's <code>pom.xml</code> if needed
+1. update the header of <code>addon/src/main/resources/com/vaadin/addon/charts/Widgetset.gwt.xml</code> manually (the plugin is configured to ignore all <code>.xml</code> files)
+
+Other places where the licensing information should be updated:
+1. <code>LICENSE.txt</code>
+1. <code>AdVaaLicen</code> tag for <code>org.apache.maven.plugins.maven-jar-plugin</code> in both <code>addon/pom.xml</code> and <code>compatibility-addon/pom.xml</code>
+1. Vaadin Charts documentation for [Vaadin 8](https://vaadin.com/docs/v8/charts/charts-overview) and [Vaadin 7](https://vaadin.com/docs/v7/charts/charts-overview)
+1. general add-on licensing documentation ([V8](https://vaadin.com/docs/v8/framework/addons) and [V7](https://vaadin.com/docs/v7/framework/addons))
+
+Removal should be considered, but update while they still exist:
+1. <code>license.html</code> and <code>README.txt</code> in <code>directory/assembly/</code>
+1. <code>documentation/charts-overview.asciidoc</code>
+1. <code>documentation/java-api/charts-installing.asciidoc</code>
diff --git a/LICENSE.txt b/LICENSE.txt
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ Vaadin Charts is a UI component add-on for Vaadin Framework 7+ which provides me
 
 ## License & Author
 
-This Add-on is distributed under [Commercial Vaadin Add-on License version 3](http://vaadin.com/license/cval-3) (CVALv3). For license terms, see LICENSE.txt.
+This Add-on is distributed under [Vaadin Commercial License and Service Terms version 2](https://vaadin.com/commercial-license-and-service-terms) (VCL-2). For license terms, see LICENSE.txt.
 
 Vaadin Charts is written by Vaadin Ltd.
 

diff --git a/addon/pom.xml b/addon/pom.xml
@@ -30,19 +30,6 @@
 		</resources>
 
 		<plugins>
-			<plugin>
-				<groupId>org.codehaus.mojo</groupId>
-				<artifactId>license-maven-plugin</artifactId>
-				<version>1.19</version>
-				<configuration>
-					<licenseName>cval3</licenseName>
-					<licenseResolver>file://${basedir}/src/license</licenseResolver>
-					<includes>
-						<include>**/main/**/*.java</include>
-					</includes>
-				</configuration>
-			</plugin>
-
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-jar-plugin</artifactId>
@@ -62,7 +49,7 @@
 							<Vaadin-Package-Version>1</Vaadin-Package-Version>
 
 							<!-- Add-on specific fields to update -->
-							<AdVaaLicen>cval</AdVaaLicen>
+							<AdVaaLicen>VCL-2</AdVaaLicen>
 							<AdVaaName>vaadin-charts</AdVaaName>
 							<AdVaaPkg>com.vaadin.addon.charts.client</AdVaaPkg>
 

diff --git a/addon/src/license/cval3/header.txt b/addon/src/license/cval3/header.txt
diff --git a/addon/src/license/header.txt b/addon/src/license/header.txt
@@ -0,0 +1,8 @@
+Vaadin Charts Addon
+
+Copyright (C) 2012-${year} Vaadin Ltd
+
+This program is available under Vaadin Commercial License and Service Terms.
+
+See <https://vaadin.com/commercial-license-and-service-terms> for the full
+license.
diff --git a/...ility-addon/src/license/cval3/license.txt → addon/src/license/license.txt b/...ility-addon/src/license/cval3/license.txt → addon/src/license/license.txt
@@ -1,11 +1,9 @@
 This Add-on component ("Software") to Vaadin Framework is distributed
-under the terms of Commercial Vaadin Add-On License version 3.0
-("CVALv3") included as LICENSE in this software package.
+under the Vaadin Commercial License and Service Terms
+("VCL-2") included as LICENSE in this software package.
 
 You must either accept the terms of the above mentioned license agreement
-or delete the Software immediately. 
+or delete the Software immediately.
 
 This software may also be available for download under alternative
-licenses at http://vaadin.com/directory.
-
-
+licenses at http://vaadin.com/directory.
diff --git a/addon/src/license/licenses.properties b/addon/src/license/licenses.properties
diff --git a/addon/src/main/java/com/vaadin/addon/charts/AbstractAxesExtremesChangeEvent.java b/addon/src/main/java/com/vaadin/addon/charts/AbstractAxesExtremesChangeEvent.java
@@ -1,21 +1,14 @@
-package com.vaadin.addon.charts;
-
-/*-
- * #%L
+/*
  * Vaadin Charts Addon
- * %%
- * Copyright (C) 2012 - 2019 Vaadin Ltd
- * %%
- * This program is available under Commercial Vaadin Add-On License 3.0
- * (CVALv3).
- * 
- * See the file licensing.txt distributed with this software for more
- * information about licensing.
- * 
- * You should have received a copy of the CVALv3 along with this program.
- * If not, see <https://vaadin.com/license/cval-3>.
- * #L%
+ *
+ * Copyright (C) 2012-2023 Vaadin Ltd
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See <https://vaadin.com/commercial-license-and-service-terms> for the full
+ * license.
  */
+package com.vaadin.addon.charts;
 
 import com.vaadin.addon.charts.model.Axis;
 import com.vaadin.ui.Component;

diff --git a/addon/src/main/java/com/vaadin/addon/charts/AbstractPointEvent.java b/addon/src/main/java/com/vaadin/addon/charts/AbstractPointEvent.java
@@ -1,21 +1,14 @@
-package com.vaadin.addon.charts;
-
-/*-
- * #%L
+/*
  * Vaadin Charts Addon
- * %%
- * Copyright (C) 2012 - 2019 Vaadin Ltd
- * %%
- * This program is available under Commercial Vaadin Add-On License 3.0
- * (CVALv3).
- * 
- * See the file licensing.txt distributed with this software for more
- * information about licensing.
- * 
- * You should have received a copy of the CVALv3 along with this program.
- * If not, see <https://vaadin.com/license/cval-3>.
- * #L%
+ *
+ * Copyright (C) 2012-2023 Vaadin Ltd
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See <https://vaadin.com/commercial-license-and-service-terms> for the full
+ * license.
  */
+package com.vaadin.addon.charts;
 
 import com.vaadin.addon.charts.model.Series;
 

diff --git a/addon/src/main/java/com/vaadin/addon/charts/AbstractSeriesEvent.java b/addon/src/main/java/com/vaadin/addon/charts/AbstractSeriesEvent.java
@@ -1,21 +1,14 @@
-package com.vaadin.addon.charts;
-
-/*-
- * #%L
+/*
  * Vaadin Charts Addon
- * %%
- * Copyright (C) 2012 - 2019 Vaadin Ltd
- * %%
- * This program is available under Commercial Vaadin Add-On License 3.0
- * (CVALv3).
- * 
- * See the file licensing.txt distributed with this software for more
- * information about licensing.
- * 
- * You should have received a copy of the CVALv3 along with this program.
- * If not, see <https://vaadin.com/license/cval-3>.
- * #L%
+ *
+ * Copyright (C) 2012-2023 Vaadin Ltd
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See <https://vaadin.com/commercial-license-and-service-terms> for the full
+ * license.
  */
+package com.vaadin.addon.charts;
 
 import com.vaadin.addon.charts.model.Series;
 import com.vaadin.ui.Component;

diff --git a/addon/src/main/java/com/vaadin/addon/charts/Chart.java b/addon/src/main/java/com/vaadin/addon/charts/Chart.java
@@ -1,21 +1,14 @@
-package com.vaadin.addon.charts;
-
-/*-
- * #%L
+/*
  * Vaadin Charts Addon
- * %%
- * Copyright (C) 2012 - 2019 Vaadin Ltd
- * %%
- * This program is available under Commercial Vaadin Add-On License 3.0
- * (CVALv3).
- * 
- * See the file licensing.txt distributed with this software for more
- * information about licensing.
- * 
- * You should have received a copy of the CVALv3 along with this program.
- * If not, see <https://vaadin.com/license/cval-3>.
- * #L%
+ *
+ * Copyright (C) 2012-2023 Vaadin Ltd
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See <https://vaadin.com/commercial-license-and-service-terms> for the full
+ * license.
  */
+package com.vaadin.addon.charts;
 
 import static com.vaadin.addon.charts.util.ChartSerialization.toJSON;
 

diff --git a/addon/src/main/java/com/vaadin/addon/charts/ChartClickEvent.java b/addon/src/main/java/com/vaadin/addon/charts/ChartClickEvent.java
@@ -1,21 +1,14 @@
-package com.vaadin.addon.charts;
-
-/*-
- * #%L
+/*
  * Vaadin Charts Addon
- * %%
- * Copyright (C) 2012 - 2019 Vaadin Ltd
- * %%
- * This program is available under Commercial Vaadin Add-On License 3.0
- * (CVALv3).
- * 
- * See the file licensing.txt distributed with this software for more
- * information about licensing.
- * 
- * You should have received a copy of the CVALv3 along with this program.
- * If not, see <https://vaadin.com/license/cval-3>.
- * #L%
+ *
+ * Copyright (C) 2012-2023 Vaadin Ltd
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See <https://vaadin.com/commercial-license-and-service-terms> for the full
+ * license.
  */
+package com.vaadin.addon.charts;
 
 import com.vaadin.addon.charts.shared.MouseEventDetails;
 import com.vaadin.addon.charts.shared.MouseEventDetails.MouseButton;

diff --git a/addon/src/main/java/com/vaadin/addon/charts/ChartClickListener.java b/addon/src/main/java/com/vaadin/addon/charts/ChartClickListener.java
@@ -1,21 +1,14 @@
-package com.vaadin.addon.charts;
-
-/*-
- * #%L
+/*
  * Vaadin Charts Addon
- * %%
- * Copyright (C) 2012 - 2019 Vaadin Ltd
- * %%
- * This program is available under Commercial Vaadin Add-On License 3.0
- * (CVALv3).
- * 
- * See the file licensing.txt distributed with this software for more
- * information about licensing.
- * 
- * You should have received a copy of the CVALv3 along with this program.
- * If not, see <https://vaadin.com/license/cval-3>.
- * #L%
+ *
+ * Copyright (C) 2012-2023 Vaadin Ltd
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See <https://vaadin.com/commercial-license-and-service-terms> for the full
+ * license.
  */
+package com.vaadin.addon.charts;
 
 import com.vaadin.event.SerializableEventListener;
 

diff --git a/addon/src/main/java/com/vaadin/addon/charts/ChartDrillupEvent.java b/addon/src/main/java/com/vaadin/addon/charts/ChartDrillupEvent.java
@@ -1,21 +1,14 @@
-package com.vaadin.addon.charts;
-
-/*-
- * #%L
+/*
  * Vaadin Charts Addon
- * %%
- * Copyright (C) 2012 - 2019 Vaadin Ltd
- * %%
- * This program is available under Commercial Vaadin Add-On License 3.0
- * (CVALv3).
- * 
- * See the file licensing.txt distributed with this software for more
- * information about licensing.
- * 
- * You should have received a copy of the CVALv3 along with this program.
- * If not, see <https://vaadin.com/license/cval-3>.
- * #L%
+ *
+ * Copyright (C) 2012-2023 Vaadin Ltd
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See <https://vaadin.com/commercial-license-and-service-terms> for the full
+ * license.
  */
+package com.vaadin.addon.charts;
 
 import com.vaadin.ui.Component;
 

diff --git a/addon/src/main/java/com/vaadin/addon/charts/ChartDrillupListener.java b/addon/src/main/java/com/vaadin/addon/charts/ChartDrillupListener.java
@@ -1,21 +1,14 @@
-package com.vaadin.addon.charts;
-
-/*-
- * #%L
+/*
  * Vaadin Charts Addon
- * %%
- * Copyright (C) 2012 - 2019 Vaadin Ltd
- * %%
- * This program is available under Commercial Vaadin Add-On License 3.0
- * (CVALv3).
- * 
- * See the file licensing.txt distributed with this software for more
- * information about licensing.
- * 
- * You should have received a copy of the CVALv3 along with this program.
- * If not, see <https://vaadin.com/license/cval-3>.
- * #L%
+ *
+ * Copyright (C) 2012-2023 Vaadin Ltd
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See <https://vaadin.com/commercial-license-and-service-terms> for the full
+ * license.
  */
+package com.vaadin.addon.charts;
 
 import com.vaadin.event.SerializableEventListener;
 

diff --git a/addon/src/main/java/com/vaadin/addon/charts/ChartOptions.java b/addon/src/main/java/com/vaadin/addon/charts/ChartOptions.java
@@ -1,21 +1,14 @@
-package com.vaadin.addon.charts;
-
-/*-
- * #%L
+/*
  * Vaadin Charts Addon
- * %%
- * Copyright (C) 2012 - 2019 Vaadin Ltd
- * %%
- * This program is available under Commercial Vaadin Add-On License 3.0
- * (CVALv3).
- * 
- * See the file licensing.txt distributed with this software for more
- * information about licensing.
- * 
- * You should have received a copy of the CVALv3 along with this program.
- * If not, see <https://vaadin.com/license/cval-3>.
- * #L%
+ *
+ * Copyright (C) 2012-2023 Vaadin Ltd
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See <https://vaadin.com/commercial-license-and-service-terms> for the full
+ * license.
  */
+package com.vaadin.addon.charts;
 
 import static com.vaadin.addon.charts.util.ChartSerialization.toJSON;