From 42e6c758254246ba80d90d47d0863ebcaf05a489 Mon Sep 17 00:00:00 2001 From: Ash Berlin-Taylor Date: Mon, 12 Nov 2018 21:18:32 +0000 Subject: [PATCH 1/5] [AIRFLOW-2779] Add license headers to doc files This adds ASF license headers to all the .rst and .md files with the exception of the Pull Request template (as that is included verbatim when opening a Pull Request on Github which would be messy) --- CONTRIBUTING.md | 19 +++++++++++++++++ README.md | 19 +++++++++++++++++ TODO.md | 19 +++++++++++++++++ UPDATING.md | 19 +++++++++++++++++ .../example_dags/example_twitter_README.md | 19 +++++++++++++++++ .../www/templates/airflow/variables/README.md | 19 +++++++++++++++++ dev/README.md | 19 +++++++++++++++++ docs/api.rst | 17 +++++++++++++++ docs/cli.rst | 17 +++++++++++++++ docs/code.rst | 17 +++++++++++++++ docs/concepts.rst | 17 +++++++++++++++ docs/faq.rst | 17 +++++++++++++++ docs/howto/executor/use-celery.rst | 17 +++++++++++++++ docs/howto/executor/use-dask.rst | 17 +++++++++++++++ docs/howto/executor/use-mesos.rst | 17 +++++++++++++++ docs/howto/index.rst | 17 +++++++++++++++ docs/howto/initialize-database.rst | 17 +++++++++++++++ docs/howto/manage-connections.rst | 17 +++++++++++++++ docs/howto/operator.rst | 17 +++++++++++++++ docs/howto/run-with-systemd.rst | 17 +++++++++++++++ docs/howto/run-with-upstart.rst | 17 +++++++++++++++ docs/howto/secure-connections.rst | 17 +++++++++++++++ docs/howto/set-config.rst | 17 +++++++++++++++ docs/howto/use-test-config.rst | 17 +++++++++++++++ docs/howto/write-logs.rst | 17 +++++++++++++++ docs/index.rst | 17 +++++++++++++++ docs/installation.rst | 17 +++++++++++++++ docs/integration.rst | 17 +++++++++++++++ docs/kubernetes.rst | 17 +++++++++++++++ docs/license.rst | 17 +++++++++++++++ docs/lineage.rst | 17 +++++++++++++++ docs/plugins.rst | 17 +++++++++++++++ docs/profiling.rst | 17 +++++++++++++++ docs/project.rst | 17 +++++++++++++++ docs/scheduler.rst | 17 +++++++++++++++ docs/security.rst | 17 +++++++++++++++ docs/start.rst | 17 +++++++++++++++ docs/timezone.rst | 17 +++++++++++++++ docs/tutorial.rst | 17 +++++++++++++++ docs/ui.rst | 17 +++++++++++++++ scripts/ci/kubernetes/README.md | 19 +++++++++++++++++ tests/dags/README.md | 19 +++++++++++++++++ tests/test_utils/README.md | 21 ++++++++++++++++++- 43 files changed, 752 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08c033c028154..5fd9bedbfe41d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,22 @@ + + # Contributing Contributions are welcome and are greatly appreciated! Every diff --git a/README.md b/README.md index d9eebeda33c4f..85c94aa8b58f2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ + + # Apache Airflow (Incubating) [![PyPI version](https://badge.fury.io/py/apache-airflow.svg)](https://badge.fury.io/py/apache-airflow) diff --git a/TODO.md b/TODO.md index 780ca207229b2..f49d99ce6f2f8 100644 --- a/TODO.md +++ b/TODO.md @@ -1,3 +1,22 @@ + + #### Roadmap items * UI page answering "Why isn't this task instance running?" diff --git a/UPDATING.md b/UPDATING.md index 909cd2649b1c7..af448cfff8419 100644 --- a/UPDATING.md +++ b/UPDATING.md @@ -1,3 +1,22 @@ + + # Updating Airflow This file documents any backwards-incompatible changes in Airflow and diff --git a/airflow/contrib/example_dags/example_twitter_README.md b/airflow/contrib/example_dags/example_twitter_README.md index 0f3aededd481d..67e95581d7e83 100644 --- a/airflow/contrib/example_dags/example_twitter_README.md +++ b/airflow/contrib/example_dags/example_twitter_README.md @@ -1,3 +1,22 @@ + + # Example Twitter DAG ***Introduction:*** This example dag depicts a typical ETL process and is a perfect use case automation scenario for Airflow. Please note that the main scripts associated with the tasks are returning None. The purpose of this DAG is to demonstrate how to write a functional DAG within Airflow. diff --git a/airflow/www/templates/airflow/variables/README.md b/airflow/www/templates/airflow/variables/README.md index bf4d80b684249..fcd00ad30fc96 100644 --- a/airflow/www/templates/airflow/variables/README.md +++ b/airflow/www/templates/airflow/variables/README.md @@ -1,3 +1,22 @@ + + # Variable Editor This folder contains forms used to edit values in the "Variable" key-value diff --git a/dev/README.md b/dev/README.md index 0b3797ee0accf..b9e9138468579 100755 --- a/dev/README.md +++ b/dev/README.md @@ -1,3 +1,22 @@ + + # Development Tools ## Airflow Pull Request Tool diff --git a/docs/api.rst b/docs/api.rst index 4ea19c8969f92..194809abc6330 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,3 +1,20 @@ +.. 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. + Experimental Rest API ===================== diff --git a/docs/cli.rst b/docs/cli.rst index f05cbfbe27ed2..4d68d0eef3b8d 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -1,3 +1,20 @@ +.. 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. + Command Line Interface ====================== diff --git a/docs/code.rst b/docs/code.rst index d30a49adbf1e7..749cbca7337f3 100644 --- a/docs/code.rst +++ b/docs/code.rst @@ -1,3 +1,20 @@ +.. 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. + API Reference ============= diff --git a/docs/concepts.rst b/docs/concepts.rst index a30a7026bc414..7c0603efa46ba 100644 --- a/docs/concepts.rst +++ b/docs/concepts.rst @@ -1,3 +1,20 @@ +.. 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. + Concepts ######## diff --git a/docs/faq.rst b/docs/faq.rst index 07c07c0bcf120..ac14fdea7ccdb 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -1,3 +1,20 @@ +.. 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. + FAQ ======== diff --git a/docs/howto/executor/use-celery.rst b/docs/howto/executor/use-celery.rst index 0e1bab060b0b2..71cae66a6f5b9 100644 --- a/docs/howto/executor/use-celery.rst +++ b/docs/howto/executor/use-celery.rst @@ -1,3 +1,20 @@ +.. 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. + Scaling Out with Celery ======================= diff --git a/docs/howto/executor/use-dask.rst b/docs/howto/executor/use-dask.rst index 769ce17e01a02..6d3efcb349a76 100644 --- a/docs/howto/executor/use-dask.rst +++ b/docs/howto/executor/use-dask.rst @@ -1,3 +1,20 @@ +.. 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. + Scaling Out with Dask ===================== diff --git a/docs/howto/executor/use-mesos.rst b/docs/howto/executor/use-mesos.rst index c3bf95a63aa36..d67579ddcb96b 100644 --- a/docs/howto/executor/use-mesos.rst +++ b/docs/howto/executor/use-mesos.rst @@ -1,3 +1,20 @@ +.. 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. + Scaling Out with Mesos (community contributed) ============================================== diff --git a/docs/howto/index.rst b/docs/howto/index.rst index f9f160e6bdbea..8a19a9ecb40a2 100644 --- a/docs/howto/index.rst +++ b/docs/howto/index.rst @@ -1,3 +1,20 @@ +.. 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. + How-to Guides ============= diff --git a/docs/howto/initialize-database.rst b/docs/howto/initialize-database.rst index c85142f35b1c2..fad75be46d25a 100644 --- a/docs/howto/initialize-database.rst +++ b/docs/howto/initialize-database.rst @@ -1,3 +1,20 @@ +.. 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. + Initializing a Database Backend =============================== diff --git a/docs/howto/manage-connections.rst b/docs/howto/manage-connections.rst index 4d0adfb1009dc..9c324d259d776 100644 --- a/docs/howto/manage-connections.rst +++ b/docs/howto/manage-connections.rst @@ -1,3 +1,20 @@ +.. 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. + Managing Connections ===================== diff --git a/docs/howto/operator.rst b/docs/howto/operator.rst index 6333e32dd7d67..2c84a7f88e888 100644 --- a/docs/howto/operator.rst +++ b/docs/howto/operator.rst @@ -1,3 +1,20 @@ +.. 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. + Using Operators =============== diff --git a/docs/howto/run-with-systemd.rst b/docs/howto/run-with-systemd.rst index 1dc138347c37a..131fc3ddc0612 100644 --- a/docs/howto/run-with-systemd.rst +++ b/docs/howto/run-with-systemd.rst @@ -1,3 +1,20 @@ +.. 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. + Running Airflow with systemd ============================ diff --git a/docs/howto/run-with-upstart.rst b/docs/howto/run-with-upstart.rst index c18a203f17b31..adfb85a31effc 100644 --- a/docs/howto/run-with-upstart.rst +++ b/docs/howto/run-with-upstart.rst @@ -1,3 +1,20 @@ +.. 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. + Running Airflow with upstart ============================ diff --git a/docs/howto/secure-connections.rst b/docs/howto/secure-connections.rst index b3b9ba193d295..719db2f3f9655 100644 --- a/docs/howto/secure-connections.rst +++ b/docs/howto/secure-connections.rst @@ -1,3 +1,20 @@ +.. 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. + Securing Connections ==================== diff --git a/docs/howto/set-config.rst b/docs/howto/set-config.rst index fc8d59da189ee..cedce11324124 100644 --- a/docs/howto/set-config.rst +++ b/docs/howto/set-config.rst @@ -1,3 +1,20 @@ +.. 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. + Setting Configuration Options ============================= diff --git a/docs/howto/use-test-config.rst b/docs/howto/use-test-config.rst index 5cb4790287992..4f272afe96f35 100644 --- a/docs/howto/use-test-config.rst +++ b/docs/howto/use-test-config.rst @@ -1,3 +1,20 @@ +.. 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. + Using the Test Mode Configuration ================================= diff --git a/docs/howto/write-logs.rst b/docs/howto/write-logs.rst index 272985a7b119a..7305ba82d6ad6 100644 --- a/docs/howto/write-logs.rst +++ b/docs/howto/write-logs.rst @@ -1,3 +1,20 @@ +.. 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. + Writing Logs ============ diff --git a/docs/index.rst b/docs/index.rst index 4cd96eaa74e43..4c18ce5ce6df9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,3 +1,20 @@ +.. 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. + .. image:: img/pin_large.png :width: 100 diff --git a/docs/installation.rst b/docs/installation.rst index bb1365ff0071e..baabea3eb0756 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,3 +1,20 @@ +.. 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. + Installation ------------ diff --git a/docs/integration.rst b/docs/integration.rst index a0445409e7e03..4c4ff81df20e5 100644 --- a/docs/integration.rst +++ b/docs/integration.rst @@ -1,3 +1,20 @@ +.. 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. + Integration =========== diff --git a/docs/kubernetes.rst b/docs/kubernetes.rst index f05f22c44543f..bb2d99e3ad5f0 100644 --- a/docs/kubernetes.rst +++ b/docs/kubernetes.rst @@ -1,3 +1,20 @@ +.. 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. + Kubernetes Executor ^^^^^^^^^^^^^^^^^^^ diff --git a/docs/license.rst b/docs/license.rst index 3c53035713267..bcb2b76bf3de6 100644 --- a/docs/license.rst +++ b/docs/license.rst @@ -1,3 +1,20 @@ +.. 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. + License ======= diff --git a/docs/lineage.rst b/docs/lineage.rst index 719ef0115eb0c..c94fe70e045c9 100644 --- a/docs/lineage.rst +++ b/docs/lineage.rst @@ -1,3 +1,20 @@ +.. 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. + Lineage ======= diff --git a/docs/plugins.rst b/docs/plugins.rst index eb44247950b07..ac52a262d4f71 100644 --- a/docs/plugins.rst +++ b/docs/plugins.rst @@ -1,3 +1,20 @@ +.. 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. + Plugins ======= diff --git a/docs/profiling.rst b/docs/profiling.rst index 37608127aea66..85c5ecc4f3a22 100644 --- a/docs/profiling.rst +++ b/docs/profiling.rst @@ -1,3 +1,20 @@ +.. 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. + .. TODO: This section would be removed after we migrate to www_rbac completely. Data Profiling diff --git a/docs/project.rst b/docs/project.rst index cd76b516de465..61e68a6984c72 100644 --- a/docs/project.rst +++ b/docs/project.rst @@ -1,3 +1,20 @@ +.. 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. + Project ======= diff --git a/docs/scheduler.rst b/docs/scheduler.rst index eb09be8d3c7e5..7075f5e0d7fab 100644 --- a/docs/scheduler.rst +++ b/docs/scheduler.rst @@ -1,3 +1,20 @@ +.. 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. + Scheduling & Triggers ===================== diff --git a/docs/security.rst b/docs/security.rst index 6502bb832c43f..8ba19c6d4a3cb 100644 --- a/docs/security.rst +++ b/docs/security.rst @@ -1,3 +1,20 @@ +.. 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. + Security ======== diff --git a/docs/start.rst b/docs/start.rst index a3e21f93f68de..e3b16b28f7fab 100644 --- a/docs/start.rst +++ b/docs/start.rst @@ -1,3 +1,20 @@ +.. 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. + Quick Start ----------- diff --git a/docs/timezone.rst b/docs/timezone.rst index 2c6f30fd39e51..3ee7346b56e59 100644 --- a/docs/timezone.rst +++ b/docs/timezone.rst @@ -1,3 +1,20 @@ +.. 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. + Time zones ========== diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 570cd75c809d9..69670d7b025cf 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -1,3 +1,20 @@ +.. 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. + Tutorial ================ diff --git a/docs/ui.rst b/docs/ui.rst index 5a09ce5aa0a92..a2f6b8514c89a 100644 --- a/docs/ui.rst +++ b/docs/ui.rst @@ -1,3 +1,20 @@ +.. 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. + UI / Screenshots ================= The Airflow UI makes it easy to monitor and troubleshoot your data pipelines. diff --git a/scripts/ci/kubernetes/README.md b/scripts/ci/kubernetes/README.md index e694bdf8e9912..575269e7b3c83 100644 --- a/scripts/ci/kubernetes/README.md +++ b/scripts/ci/kubernetes/README.md @@ -1,3 +1,22 @@ + + # Airflow on Kubernetes If you don't have minikube installed, please run `./minikube/start_minikube.sh` to start a k8s-instance on your local machine. Make sure that your `kubectl` is pointing to the local k8s instance. diff --git a/tests/dags/README.md b/tests/dags/README.md index c5d6acb0f4c2b..615e8ab7f6968 100644 --- a/tests/dags/README.md +++ b/tests/dags/README.md @@ -1,3 +1,22 @@ + + # Unit Tests DAGs Folder This folder contains DAGs for Airflow unit testing. diff --git a/tests/test_utils/README.md b/tests/test_utils/README.md index 8a5c90dfd25f4..a93a0aa34c13c 100644 --- a/tests/test_utils/README.md +++ b/tests/test_utils/README.md @@ -1 +1,20 @@ -Utilities for use in tests. + + +# Utilities for use in tests. From 65e3ebf2167218e1fd5de8e9c7acffa827bb4929 Mon Sep 17 00:00:00 2001 From: Ash Berlin-Taylor Date: Tue, 13 Nov 2018 11:03:55 +0000 Subject: [PATCH 2/5] fixup! [AIRFLOW-2779] Add license headers to doc files --- .rat-excludes | 10 +++++++--- docs/conf.py | 19 ++++++++++++++++++- scripts/ci/6-check-license.sh | 24 ++++++------------------ 3 files changed, 31 insertions(+), 22 deletions(-) diff --git a/.rat-excludes b/.rat-excludes index b13c1648c47b3..bca0584b40f27 100644 --- a/.rat-excludes +++ b/.rat-excludes @@ -11,8 +11,6 @@ requirements.txt .travis.yml .*pyc .*lock -docs -.*md dist build airflow.egg-info @@ -29,7 +27,6 @@ CHANGELOG.txt kerberos_auth.py airflow_api_auth_backend_kerberos_auth_py.html licenses/* -airflow/www/static/docs parallel.js underscore.js jquery.dataTables.min.js @@ -41,3 +38,10 @@ d3.v3.min.js ace.js airflow/www_rbac/node_modules .*json +airflow/www/static/coverage/* +git_version +flake8_diff.sh + +rat-results.txt +apache-airflow-.*\+incubating-source.tar.gz.* +apache-airflow-.*\+incubating-bin.tar.gz.* diff --git a/docs/conf.py b/docs/conf.py index b26c2191cf8f4..fa2a3d2274acb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,7 +3,24 @@ # flake8: noqa # Disable Flake8 because of all the sphinx imports # -# Airflow documentation build configuration file, created by +# 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. + +# Airflow documentation build configuration file, created by # sphinx-quickstart on Thu Oct 9 20:50:01 2014. # # This file is execfile()d with the current directory set to its diff --git a/scripts/ci/6-check-license.sh b/scripts/ci/6-check-license.sh index 52d49896feedd..8f3999043b14d 100755 --- a/scripts/ci/6-check-license.sh +++ b/scripts/ci/6-check-license.sh @@ -71,6 +71,9 @@ mkdir -p ${TMP_DIR}/lib exit 1 } +# This is the target of a symlink in airflow/www/static/docs - and rat exclude doesn't cope with the symlink target doesn't exist +mkdir -p docs/_build/html/ + echo "Running license checks. This can take a while." $java_cmd -jar "$rat_jar" -E "$FWDIR"/.rat-excludes -d "$FWDIR" > rat-results.txt @@ -82,24 +85,9 @@ fi ERRORS="$(cat rat-results.txt | grep -e "??")" if test ! -z "$ERRORS"; then - echo "Could not find Apache license headers in the following files:" - echo "$ERRORS" - COUNT=`echo "${ERRORS}" | wc -l` - # due to old builds can be removed later - rm -rf ${TMP_DIR}/rat-error-count - if [ ! -f ${TMP_DIR}/rat-error-count-builds ]; then - [ "${TRAVIS_PULL_REQUEST}" = "false" ] && echo ${COUNT} > ${TMP_DIR}/rat-error-count-builds - OLD_COUNT=${COUNT} - else - typeset -i OLD_COUNT=$(cat ${TMP_DIR}/rat-error-count-builds) - fi - if [ ${COUNT} -gt ${OLD_COUNT} ]; then - echo "New missing licenses (${COUNT} vs ${OLD_COUNT}) detected. Please correct them by adding them to to header of your files" - exit 1 - else - [ "${TRAVIS_PULL_REQUEST}" = "false" ] && echo ${COUNT} > ${TMP_DIR}/rat-error-count-builds - fi - exit 0 + echo >&2 "Could not find Apache license headers in the following files:" + echo >&2 "$ERRORS" + exit 1 else echo -e "RAT checks passed." fi From 8b7bca7d322d2ebdc94dc7ec647f727d10ec2911 Mon Sep 17 00:00:00 2001 From: Ash Berlin-Taylor Date: Tue, 13 Nov 2018 12:09:10 +0000 Subject: [PATCH 3/5] fixup! [AIRFLOW-2779] Add license headers to doc files --- .rat-excludes | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.rat-excludes b/.rat-excludes index bca0584b40f27..b9ba769154a61 100644 --- a/.rat-excludes +++ b/.rat-excludes @@ -1,5 +1,9 @@ +# Note: these patterns are applied to single files or directories, not full paths +# coverage/* will ignore any coverage dir, but airflow/www/static/coverage/* will match nothing + .gitignore .gitattributes +.airflowignore .coverage .coveragerc .codecov.yml @@ -18,10 +22,13 @@ apache_airflow.egg-info .idea metastore_db .*sql +.*svg .*csv CHANGELOG.txt .*zip .*lock +.*html +_build/* # Apache Rat does not detect BSD-2 clause properly # it is compatible according to http://www.apache.org/legal/resolved.html#category-a kerberos_auth.py From 866b20d92e219dea14e8e3222eb1ce7383de1a61 Mon Sep 17 00:00:00 2001 From: Ash Berlin-Taylor Date: Tue, 13 Nov 2018 12:09:44 +0000 Subject: [PATCH 4/5] fixup! [AIRFLOW-2779] Add license headers to doc files --- .rat-excludes | 1 + 1 file changed, 1 insertion(+) diff --git a/.rat-excludes b/.rat-excludes index b9ba769154a61..00b98dd6a8411 100644 --- a/.rat-excludes +++ b/.rat-excludes @@ -29,6 +29,7 @@ CHANGELOG.txt .*lock .*html _build/* +_static/* # Apache Rat does not detect BSD-2 clause properly # it is compatible according to http://www.apache.org/legal/resolved.html#category-a kerberos_auth.py From 449533feddf4d0a507b75c39cef6eafc9c2ab46c Mon Sep 17 00:00:00 2001 From: Ash Berlin-Taylor Date: Tue, 13 Nov 2018 12:10:51 +0000 Subject: [PATCH 5/5] fixup! [AIRFLOW-2779] Add license headers to doc files --- .rat-excludes | 9 +++++++-- tests/contrib/operators/test_file_to_gcs.py | 20 ++++++++++++++++++++ 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/.rat-excludes b/.rat-excludes index 00b98dd6a8411..05f7b98000f89 100644 --- a/.rat-excludes +++ b/.rat-excludes @@ -9,6 +9,7 @@ .codecov.yml .eslintrc .eslintignore +.flake8 .rat-excludes requirements.txt .*log @@ -27,9 +28,13 @@ metastore_db CHANGELOG.txt .*zip .*lock +# Generated doc files .*html _build/* _static/* +.buildinfo +searchindex.js + # Apache Rat does not detect BSD-2 clause properly # it is compatible according to http://www.apache.org/legal/resolved.html#category-a kerberos_auth.py @@ -44,9 +49,9 @@ bootstrap-toggle.min.js bootstrap-toggle.min.css d3.v3.min.js ace.js -airflow/www_rbac/node_modules +node_modules/* .*json -airflow/www/static/coverage/* +coverage/* git_version flake8_diff.sh diff --git a/tests/contrib/operators/test_file_to_gcs.py b/tests/contrib/operators/test_file_to_gcs.py index 590267a319e96..7e20579ecda92 100644 --- a/tests/contrib/operators/test_file_to_gcs.py +++ b/tests/contrib/operators/test_file_to_gcs.py @@ -1,3 +1,23 @@ +# -*- coding: utf-8 -*- +# +# 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. +# + import datetime import unittest