You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hop.apache.org by ha...@apache.org on 2021/09/08 09:36:27 UTC
[incubator-hop] branch master updated: HOP-3204 - document variable
HOP_LICENSE_HEADER_FILE
This is an automated email from the ASF dual-hosted git repository.
hansva pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hop.git
The following commit(s) were added to refs/heads/master by this push:
new 4ba63e5 HOP-3204 - document variable HOP_LICENSE_HEADER_FILE
new 4252084 Merge pull request #1042 from bamaer/HOP-3204
4ba63e5 is described below
commit 4ba63e5119a278ca7121a58f273e2c08cc3a341a
Author: Bart Maertens <ba...@know.bi>
AuthorDate: Tue Sep 7 21:21:45 2021 +0200
HOP-3204 - document variable HOP_LICENSE_HEADER_FILE
---
.../ROOT/assets/images/hop-license-header-file.png | Bin 0 -> 27464 bytes
.../modules/ROOT/pages/integration-testing.adoc | 4 +++
.../modules/ROOT/pages/plugin-samples.adoc | 3 +++
.../pages/snippets/hop-license-header-file.adoc | 30 +++++++++++++++++++++
4 files changed, 37 insertions(+)
diff --git a/docs/hop-dev-manual/modules/ROOT/assets/images/hop-license-header-file.png b/docs/hop-dev-manual/modules/ROOT/assets/images/hop-license-header-file.png
new file mode 100644
index 0000000..fb0e9c8
Binary files /dev/null and b/docs/hop-dev-manual/modules/ROOT/assets/images/hop-license-header-file.png differ
diff --git a/docs/hop-dev-manual/modules/ROOT/pages/integration-testing.adoc b/docs/hop-dev-manual/modules/ROOT/pages/integration-testing.adoc
index 9bb5337..a7e7e0f 100644
--- a/docs/hop-dev-manual/modules/ROOT/pages/integration-testing.adoc
+++ b/docs/hop-dev-manual/modules/ROOT/pages/integration-testing.adoc
@@ -163,3 +163,7 @@ ok;
----
This script reads the log returned by the previous pipeline and parses it to search for values.
+
+
+// Include hop license header snippet
+include::snippets/hop-license-header-file.adoc[]
\ No newline at end of file
diff --git a/docs/hop-dev-manual/modules/ROOT/pages/plugin-samples.adoc b/docs/hop-dev-manual/modules/ROOT/pages/plugin-samples.adoc
index ac777d5..1fe21bf 100644
--- a/docs/hop-dev-manual/modules/ROOT/pages/plugin-samples.adoc
+++ b/docs/hop-dev-manual/modules/ROOT/pages/plugin-samples.adoc
@@ -68,3 +68,6 @@ Keep things clean.
* Create notes in pipelines and workflows explaining what happens.
Make the note font large enough: 11 or higher.
+
+// Include hop license header snippet
+include::snippets/hop-license-header-file.adoc[]
\ No newline at end of file
diff --git a/docs/hop-dev-manual/modules/ROOT/pages/snippets/hop-license-header-file.adoc b/docs/hop-dev-manual/modules/ROOT/pages/snippets/hop-license-header-file.adoc
new file mode 100644
index 0000000..a24b55e
--- /dev/null
+++ b/docs/hop-dev-manual/modules/ROOT/pages/snippets/hop-license-header-file.adoc
@@ -0,0 +1,30 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you 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.
+////
+
+== Set the `HOP_LICENSE_HEADER_FILE` project variable
+
+All files that are shipped with Apache software need to contain the Apache Software Foundation's header.
+
+This also applies to all workflows and pipelines that are shipped as integration tests, samples or in any other form.
+
+To spare contributors the pain of manually having to add the ASF license header in workflows and pipeline, Hop Gui supports the `HOP_LICENSE_HEADER_FILE` project variable.
+
+Set this variable in your project and point it to a file containing the ASF Header's text, e.g. `integration-tests/asf-header.txt` to let Hop include the ASF header in all of your workflows and pipelines.
+
+image:hop-license-header-file.png[Hop License Header File variable, width="90%"]
+
+As with any other piece of code, run `mvn apache-rat:check` to verify all files contain the correct headers before contributing your test or sample workflows and pipelines.
\ No newline at end of file