etcd-io · fanminshi · Mar 28, 2019 · Mar 27, 2019
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,6 +21,7 @@ This is a rough outline of what a contributor's workflow looks like:
 
 - Create a topic branch from where to base the contribution. This is usually master.
 - Make commits of logical units.
+- Run `license:format` to make sure license headers are properly formatted (see below).
 - Make sure commit messages are in the proper format (see below).
 - Push changes in a topic branch to a personal fork of the repository.
 - Submit a pull request to etcd-io/jetcd.
@@ -34,6 +35,16 @@ The coding style follows Google Java Style. See the [style doc](https://google.g
 
 Please follow this style to make jetcd easy to review, maintain, and develop.
 
+### License headers
+
+To make sure CI checks would pass please run
+
+```bash
+./mvnw license:format
+```
+
+and including any changes in PR before opening it.
+
 ### Format of the commit message
 
 We follow a rough convention for commit messages that is designed to answer two

diff --git a/etc/checkstyle.xml b/etc/checkstyle.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <!--
 
-    Copyright 2017 The jetcd authors
+    Copyright 2016-2019 The jetcd authors
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.

diff --git a/etc/license-formatting.xml b/etc/license-formatting.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright 2016-2019 The jetcd authors
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+-->
+<additionalHeaders>
+    <SLASHSTART_WITH_BLANKLINE_STYLE>
+        <firstLine><![CDATA[/*]]></firstLine>
+        <beforeEachLine><![CDATA[ * ]]></beforeEachLine>
+        <endLine><![CDATA[ */EOL]]></endLine>
+        <firstLineDetectionPattern><![CDATA[(EOL)*(\s|\t)*/\*.*$]]></firstLineDetectionPattern>
+        <lastLineDetectionPattern><![CDATA[.*\*/(\s|\t)*$]]></lastLineDetectionPattern>
+        <allowBlankLines>false</allowBlankLines>
+        <isMultiline>true</isMultiline>
+        <padLines>false</padLines>
+    </SLASHSTART_WITH_BLANKLINE_STYLE>
+</additionalHeaders>
diff --git a/etc/license.txt b/etc/license.txt
@@ -1,4 +1,4 @@
-Copyright 2017 The jetcd authors
+Copyright ${license.git.copyrightYears} The jetcd authors
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/etc/mvn-deploy-settings.xml b/etc/mvn-deploy-settings.xml
@@ -1,8 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
 
-    Copyright 2017 The jetcd authors
+    Copyright 2016-2019 The jetcd authors
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
@@ -17,7 +16,6 @@
     limitations under the License.
 
 -->
-
 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="

diff --git a/etc/versions-rules.xml b/etc/versions-rules.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-    Copyright 2017 The jetcd authors
+    Copyright 2016-2019 The jetcd authors
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.

diff --git a/jetcd-all/pom.xml b/jetcd-all/pom.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-    Copyright 2017 The jetcd authors
+    Copyright 2016-2019 The jetcd authors
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.

diff --git a/jetcd-all/src/main/java/io/etcd/jetcd/all/JetcdAll.java b/jetcd-all/src/main/java/io/etcd/jetcd/all/JetcdAll.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-all/src/main/java/io/etcd/jetcd/all/package-info.java b/jetcd-all/src/main/java/io/etcd/jetcd/all/package-info.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-common/pom.xml b/jetcd-common/pom.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-    Copyright 2017 The jetcd authors
+    Copyright 2016-2019 The jetcd authors
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.

diff --git a/jetcd-common/src/main/java/io/etcd/jetcd/common/exception/ClosedClientException.java b/jetcd-common/src/main/java/io/etcd/jetcd/common/exception/ClosedClientException.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/...common/src/main/java/io/etcd/jetcd/common/exception/ClosedKeepAliveListenerException.java b/...common/src/main/java/io/etcd/jetcd/common/exception/ClosedKeepAliveListenerException.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-common/src/main/java/io/etcd/jetcd/common/exception/ClosedSnapshotException.java b/jetcd-common/src/main/java/io/etcd/jetcd/common/exception/ClosedSnapshotException.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-common/src/main/java/io/etcd/jetcd/common/exception/ClosedWatcherException.java b/jetcd-common/src/main/java/io/etcd/jetcd/common/exception/ClosedWatcherException.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-common/src/main/java/io/etcd/jetcd/common/exception/CompactedException.java b/jetcd-common/src/main/java/io/etcd/jetcd/common/exception/CompactedException.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-common/src/main/java/io/etcd/jetcd/common/exception/EtcdException.java b/jetcd-common/src/main/java/io/etcd/jetcd/common/exception/EtcdException.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-common/src/main/java/io/etcd/jetcd/common/exception/EtcdExceptionFactory.java b/jetcd-common/src/main/java/io/etcd/jetcd/common/exception/EtcdExceptionFactory.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/pom.xml b/jetcd-core/pom.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-    Copyright 2017 The jetcd authors
+    Copyright 2016-2019 The jetcd authors
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/AbstractResponse.java b/jetcd-core/src/main/java/io/etcd/jetcd/AbstractResponse.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/Auth.java b/jetcd-core/src/main/java/io/etcd/jetcd/Auth.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/AuthImpl.java b/jetcd-core/src/main/java/io/etcd/jetcd/AuthImpl.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/ByteSequence.java b/jetcd-core/src/main/java/io/etcd/jetcd/ByteSequence.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/Client.java b/jetcd-core/src/main/java/io/etcd/jetcd/Client.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/ClientBuilder.java b/jetcd-core/src/main/java/io/etcd/jetcd/ClientBuilder.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/ClientConnectionManager.java b/jetcd-core/src/main/java/io/etcd/jetcd/ClientConnectionManager.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/ClientImpl.java b/jetcd-core/src/main/java/io/etcd/jetcd/ClientImpl.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/CloseableClient.java b/jetcd-core/src/main/java/io/etcd/jetcd/CloseableClient.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/Cluster.java b/jetcd-core/src/main/java/io/etcd/jetcd/Cluster.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/ClusterImpl.java b/jetcd-core/src/main/java/io/etcd/jetcd/ClusterImpl.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/Constants.java b/jetcd-core/src/main/java/io/etcd/jetcd/Constants.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/KV.java b/jetcd-core/src/main/java/io/etcd/jetcd/KV.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/KVImpl.java b/jetcd-core/src/main/java/io/etcd/jetcd/KVImpl.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/KeyValue.java b/jetcd-core/src/main/java/io/etcd/jetcd/KeyValue.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/Lease.java b/jetcd-core/src/main/java/io/etcd/jetcd/Lease.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/LeaseImpl.java b/jetcd-core/src/main/java/io/etcd/jetcd/LeaseImpl.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/Lock.java b/jetcd-core/src/main/java/io/etcd/jetcd/Lock.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/LockImpl.java b/jetcd-core/src/main/java/io/etcd/jetcd/LockImpl.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/Maintenance.java b/jetcd-core/src/main/java/io/etcd/jetcd/Maintenance.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/MaintenanceImpl.java b/jetcd-core/src/main/java/io/etcd/jetcd/MaintenanceImpl.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/Observers.java b/jetcd-core/src/main/java/io/etcd/jetcd/Observers.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/Response.java b/jetcd-core/src/main/java/io/etcd/jetcd/Response.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/Txn.java b/jetcd-core/src/main/java/io/etcd/jetcd/Txn.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/jetcd-core/src/main/java/io/etcd/jetcd/Util.java b/jetcd-core/src/main/java/io/etcd/jetcd/Util.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2017 The jetcd authors
+/*
+ * Copyright 2016-2019 The jetcd authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.