Doc: Insert license header in all source files (#664)

* doc: Add license header * add license to yaml files * pep8 fix: too many blank lines --------- Co-authored-by: Sugetha Chandhrasekar <[email protected]>
aristanetworks · Nov 21, 2023 · cf34b42 · cf34b42
1 parent 290363f
commit cf34b42
Show file tree

Hide file tree

Showing 135 changed files with 618 additions and 490 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,6 +8,58 @@ repos:
       - id: end-of-file-fixer
       - id: check-added-large-files
       - id: check-merge-conflict
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.4
+    hooks:
+      - name: Check and insert license on Python files
+        id: insert-license
+        exclude: .*\__init__.py$
+        files: .*\.py$
+        args:
+          - --license-filepath
+          - development/license-short.txt
+          - --use-current-year
+          - --allow-past-years
+          - --fuzzy-match-generates-todo
+          - --no-extra-eol
+
+      - name: Check and insert license on select YAML files
+        id: insert-license
+        files: ansible_collections/arista/cvp/roles/.*/(handlers|tasks)/.*\.yml$
+        args:
+          - --license-filepath
+          - development/license-short.txt
+          - --use-current-year
+          - --allow-past-years
+          - --fuzzy-match-generates-todo
+          - --no-extra-eol
+
+      - name: Check and insert license on Jinja2 files
+        id: insert-license
+        files: .*\.j2$
+        exclude: ansible_collections/arista/cvp/molecule.*
+        args:
+          - --license-filepath
+          - development/license-short.txt
+          - --use-current-year
+          - --allow-past-years
+          - --fuzzy-match-generates-todo
+          - --comment-style
+          - '{#||#}'
+          - --no-extra-eol
+
+      - name: Check and insert license on Markdown files
+        id: insert-license
+        files: .*\.md$
+        exclude: (ansible_collections/arista/cvp/molecule|.github|ansible_collections/arista/cvp/examples/.+/documentation/).*
+        args:
+          - --license-filepath
+          - development/license-short.txt
+          - --use-current-year
+          - --allow-past-years
+          - --fuzzy-match-generates-todo
+          - --comment-style
+          - '<!--|  ~|  -->'
 
   - repo: https://github.com/pycqa/pylint
     rev: "v2.16.1"

diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Ansible Modules for Arista CloudVision Platform
 
 ![Arista CVP](https://img.shields.io/badge/Arista-CVP%20Automation-blue) ![[collection version](https://github.com/aristanetworks/ansible-cvp/tags)](https://img.shields.io/github/v/release/aristanetworks/ansible-cvp) ![License](https://img.shields.io/github/license/aristanetworks/ansible-cvp) [![Collection code testing](https://github.com/aristanetworks/ansible-cvp/actions/workflows/pull-request-management.yml/badge.svg)](https://github.com/aristanetworks/ansible-cvp/actions/workflows/pull-request-management.yml)

diff --git a/ansible_collections/arista/cvp/README.md b/ansible_collections/arista/cvp/README.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Ansible Modules for Arista CloudVision Platform
 
 ## About

diff --git a/ansible_collections/arista/cvp/docs/build-md/doc.py b/ansible_collections/arista/cvp/docs/build-md/doc.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2023 Arista Networks, Inc.
+# Use of this source code is governed by the Apache License 2.0
+# that can be found in the LICENSE file.
 import os
 from pathlib import Path
 

diff --git a/ansible_collections/arista/cvp/docs/build-md/templates/md.j2 b/ansible_collections/arista/cvp/docs/build-md/templates/md.j2
@@ -1,3 +1,8 @@
+{#
+ Copyright (c) 2023 Arista Networks, Inc.
+ Use of this source code is governed by the Apache License 2.0
+ that can be found in the LICENSE file.
+#}
 # {{ name }}
 
 {{ module.doc.short_description }}

diff --git a/ansible_collections/arista/cvp/docs/contributing.md b/ansible_collections/arista/cvp/docs/contributing.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Contribute to Arista ansible-cvp collection
 
 Please take a moment to review this document in order to make the contribution

diff --git a/ansible_collections/arista/cvp/docs/faq/containers.md b/ansible_collections/arista/cvp/docs/faq/containers.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Ansible Execution Environment
 
 ## Ansible EE and builder overview

diff --git a/ansible_collections/arista/cvp/docs/faq/errors.md b/ansible_collections/arista/cvp/docs/faq/errors.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Common Error messages
 
 > All Ansible error messages should be read from bottom to top.

diff --git a/ansible_collections/arista/cvp/docs/getting-started.md b/ansible_collections/arista/cvp/docs/getting-started.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Getting Started
 
 This example outlines how to use `arista.cvp` to create a containers topology on Arista CloudVision.

diff --git a/ansible_collections/arista/cvp/docs/how-to/cvp-authentication.md b/ansible_collections/arista/cvp/docs/how-to/cvp-authentication.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # CloudVision Authentication
 
 CloudVision supports 2 different types of authentication depending on what kind of instance you are targeting:

diff --git a/ansible_collections/arista/cvp/docs/how-to/debug.md b/ansible_collections/arista/cvp/docs/how-to/debug.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Debug logs
 
 If required, `arista.cvp` collection supports debug log to get more information about process execution and save all these information in a log file.

diff --git a/ansible_collections/arista/cvp/docs/installation/collection-installation.md b/ansible_collections/arista/cvp/docs/installation/collection-installation.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Collection installation
 
 These instructions are for regular users to install via Ansible Galaxy. To setup a development environment use [these](https://www.avd.sh/en/devel/docs/contribution/overview.html) instructions.

diff --git a/ansible_collections/arista/cvp/docs/installation/requirements.md b/ansible_collections/arista/cvp/docs/installation/requirements.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Requirements
 
 ## Arista EOS version

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_change_control_v3.md b/ansible_collections/arista/cvp/docs/modules/cv_change_control_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_change_control_v3
 
 Change Control management with CloudVision

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_configlet.md b/ansible_collections/arista/cvp/docs/modules/cv_configlet.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_configlet
 
 Create, Delete, or Update CloudVision Portal Configlets.

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_configlet_v3.md b/ansible_collections/arista/cvp/docs/modules/cv_configlet_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_configlet_v3
 
 Create, Delete, or Update CloudVision Portal Configlets.

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_container.md b/ansible_collections/arista/cvp/docs/modules/cv_container.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_container
 
 Manage Provisioning topology.

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_container_v3.md b/ansible_collections/arista/cvp/docs/modules/cv_container_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_container_v3
 
 Manage Provisioning topology.

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_device.md b/ansible_collections/arista/cvp/docs/modules/cv_device.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_device
 
 Provision, Reset, or Update CloudVision Portal Devices.

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_device_v3.md b/ansible_collections/arista/cvp/docs/modules/cv_device_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_device_v3
 
 Manage Provisioning topology.

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_facts.md b/ansible_collections/arista/cvp/docs/modules/cv_facts.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_facts
 
 Collect facts from CloudVision Portal.

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_facts_v3.md b/ansible_collections/arista/cvp/docs/modules/cv_facts_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_facts_v3
 
 Collect facts from CloudVision

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_image_v3.md b/ansible_collections/arista/cvp/docs/modules/cv_image_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_image_v3
 
 EOS Image management with CloudVision

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_tag_v3.md b/ansible_collections/arista/cvp/docs/modules/cv_tag_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_tag_v3
 
 Create/Assign/Delete/Unassign tags on CVP

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_task.md b/ansible_collections/arista/cvp/docs/modules/cv_task.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_task
 
 Execute or Cancel CVP Tasks.

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_task_v3.md b/ansible_collections/arista/cvp/docs/modules/cv_task_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_task_v3
 
 Execute or Cancel CVP Tasks.

diff --git a/ansible_collections/arista/cvp/docs/modules/cv_validate_v3.md b/ansible_collections/arista/cvp/docs/modules/cv_validate_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # cv_validate_v3
 
 CVP/Local configlet Validation

diff --git a/ansible_collections/arista/cvp/docs/release-notes/v1.x.md b/ansible_collections/arista/cvp/docs/release-notes/v1.x.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Release Notes For Ansible CVP 1.x
 
 ## Release v1.1.2

diff --git a/ansible_collections/arista/cvp/docs/release-notes/v2.x.md b/ansible_collections/arista/cvp/docs/release-notes/v2.x.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Release Notes For Ansible CVP 2.x
 
 !!! info

diff --git a/ansible_collections/arista/cvp/docs/release-notes/v3.x.md b/ansible_collections/arista/cvp/docs/release-notes/v3.x.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Release Notes For Ansible CVP 3.x
 
 !!! info

diff --git a/ansible_collections/arista/cvp/docs/schema/cv_change_control_v3.md b/ansible_collections/arista/cvp/docs/schema/cv_change_control_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Schema for cv_change_control_v3
 
 | Variable | Type | Required | Default | Choices | Description |

diff --git a/ansible_collections/arista/cvp/docs/schema/cv_container_v3.md b/ansible_collections/arista/cvp/docs/schema/cv_container_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Schema for cv_container_v3
 
 | Variable | Type | Required | Default | Choices | Description |

diff --git a/ansible_collections/arista/cvp/docs/schema/cv_device_v3.md b/ansible_collections/arista/cvp/docs/schema/cv_device_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Schema for cv_device_v3
 
 | Variable | Type | Required | Default | Choices | Description |

diff --git a/ansible_collections/arista/cvp/docs/schema/cv_tag_v3.md b/ansible_collections/arista/cvp/docs/schema/cv_tag_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Schema for cv_tag_v3
 
 | Variable | Type | Required | Default | Choices | Description |

diff --git a/ansible_collections/arista/cvp/docs/schema/cv_validate_v3.md b/ansible_collections/arista/cvp/docs/schema/cv_validate_v3.md
@@ -1,3 +1,9 @@
+<!--
+  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Use of this source code is governed by the Apache License 2.0
+  ~ that can be found in the LICENSE file.
+  -->
+
 # Schema for cv_validate_v3
 
 | Variable | Type | Required | Default | Choices | Description |