Move license header to wherehows-docs & update documentation (#698)

Fix license checking for Play-based projects and fix violated files
datahub-project · Aug 23, 2017 · 03ba2bc · 03ba2bc
1 parent 4b30623
commit 03ba2bc
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 7 deletions.
diff --git a/gradle/scripts/license.gradle b/gradle/scripts/license.gradle
@@ -1,6 +1,6 @@
 apply plugin: 'license'
 
-ext.licenseFile = file('.license_header.txt')
+ext.licenseFile = file('wherehows-docs/license_header.txt')
 
 subprojects {
   apply plugin: 'com.github.hierynomus.license'

diff --git a/gradle/scripts/play.gradle b/gradle/scripts/play.gradle
@@ -4,6 +4,15 @@ tasks.withType(PlayRun) {
     httpPort = project.ext.httpPort
 }
 
+// Manually define a sourceSet for license checking
+sourceSets {
+  licsense {
+    java {
+        srcDirs = ['app', 'test']
+    }
+  }
+}
+
 model {
     components {
         play {

diff --git a/wherehows-backend/app/controllers/Application.java b/wherehows-backend/app/controllers/Application.java
@@ -1,12 +1,12 @@
 /**
  * Copyright 2015 LinkedIn Corp. All rights reserved.
- * <p>
+ *
  * 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
- * <p>
+ *
  * http://www.apache.org/licenses/LICENSE-2.0
- * <p>
+ *
  * 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.

diff --git a/wherehows-docs/coding-guidelines.md b/wherehows-docs/coding-guidelines.md
@@ -1,6 +1,9 @@
 # Code formatting
 Use standard [LinkedIn code style](LinkedIn%20Style.xml) in IntelliJ to format the code.
 
+# License Header
+Please add the [Apache License Header](license_header.txt) to all source files. You can automate this using the `licenseFormat` gradle task.
+
 # Testing
 > Note: Info here is for pre-v1.0.0 and will need to be updated
 

diff --git a/.license_header.txt → wherehows-docs/license_header.txt b/.license_header.txt → wherehows-docs/license_header.txt
diff --git a/wherehows-frontend/app/controllers/Application.java b/wherehows-frontend/app/controllers/Application.java
@@ -1,12 +1,12 @@
 /**
  * Copyright 2015 LinkedIn Corp. All rights reserved.
- * <p>
+ *
  * 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
- * <p>
+ *
  * http://www.apache.org/licenses/LICENSE-2.0
- * <p>
+ *
  * 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.

diff --git a/wherehows-frontend/test/ApplicationTest.java b/wherehows-frontend/test/ApplicationTest.java
@@ -1,3 +1,16 @@
+/**
+ * Copyright 2015 LinkedIn Corp. All rights reserved.
+ *
+ * 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.
+ */
 import org.junit.*;
 
 import play.twirl.api.Content;

diff --git a/wherehows-frontend/test/ControllersTest.java b/wherehows-frontend/test/ControllersTest.java
@@ -1,3 +1,16 @@
+/**
+ * Copyright 2015 LinkedIn Corp. All rights reserved.
+ *
+ * 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.
+ */
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.node.ArrayNode;

diff --git a/wherehows-frontend/test/IntegrationTest.java b/wherehows-frontend/test/IntegrationTest.java
@@ -1,3 +1,16 @@
+/**
+ * Copyright 2015 LinkedIn Corp. All rights reserved.
+ *
+ * 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.
+ */
 import org.junit.*;
 
 import play.libs.ws.WS;