gh-1001: Improve process for updating copyright headers (#1002)

* Enable use of spotless copyright header check

* Remove checkstyle header checks

* Fix typo

.github/workflows/continuous-integration.yaml

@@ -111,7 +111,9 @@ jobs:
     env:
       MAVEN_OPTS: -Dmaven.wagon.http.retryHandler.count=3 -Dmaven.wagon.httpconnectionManager.ttlSeconds=25
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
 
     - name: Setup JDK
       uses: actions/setup-java@v2
@@ -133,5 +135,9 @@ jobs:
     - name: Test
       run: mvn verify -B -P coverage -pl ${{matrix.modules}}
 
+    - name: Check Copyright Headers
+      if: github.event_name == 'pull_request'
+      run: mvn -B -q spotless:check -pl ${{matrix.modules}}
+
     - name: Upload Coverage
       uses: codecov/codecov-action@v2

code-style/checkstyle.xml

@@ -33,10 +33,6 @@
         <property name="id" value="fileTabChar"/>
         <property name="eachLine" value="true"/>
     </module>
-    <module name="RegexpHeader">
-        <property name="id" value="headerCheck"/>
-        <property name="headerFile" value="${checkstyle.header.file}"/>
-    </module>
 
     <module name="RegexpSingleline">
         <property name="id" value="trailingSpaces"/>

code-style/licence-header-java.txt

@@ -0,0 +1,16 @@
+/*
+ * Copyright $YEAR Crown Copyright
+ *
+ * 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.
+ */
+

code-style/licence-header-pom.txt

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright $YEAR Crown Copyright
+  ~
+  ~ 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.
+  -->
+

pom.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  ~ Copyright 2016-2019 Crown Copyright
+  ~ Copyright 2016-2022 Crown Copyright
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.
@@ -85,8 +85,6 @@
                     <encoding>UTF-8</encoding>
                     <consoleOutput>true</consoleOutput>
                     <failsOnError>true</failsOnError>
-                    <headerLocation>code-style/licenseHeader.txt
-                    </headerLocation>
                     <excludes>**/generated/**/*</excludes>
                     <sourceDirectories>
                         <sourceDirectory>${project.build.sourceDirectory}
@@ -105,8 +103,6 @@
                             <encoding>UTF-8</encoding>
                             <consoleOutput>true</consoleOutput>
                             <failsOnError>true</failsOnError>
-                            <headerLocation>code-style/licenseHeader.txt
-                            </headerLocation>
                         </configuration>
                         <goals>
                             <goal>check</goal>