Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Insert license header in all source files #664

Merged
merged 3 commits into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions ansible_collections/arista/cvp/docs/build-md/doc.py
Original file line number Diff line number Diff line change
@@ -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

Expand Down
5 changes: 5 additions & 0 deletions ansible_collections/arista/cvp/docs/build-md/templates/md.j2
Original file line number Diff line number Diff line change
@@ -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 }}
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/contributing.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/faq/containers.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/faq/errors.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/how-to/debug.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/modules/cv_configlet.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/modules/cv_container.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/modules/cv_device.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/modules/cv_device_v3.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/modules/cv_facts.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/modules/cv_facts_v3.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/modules/cv_image_v3.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/modules/cv_tag_v3.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/modules/cv_task.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/modules/cv_task_v3.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/modules/cv_validate_v3.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/release-notes/v1.x.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/release-notes/v2.x.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/release-notes/v3.x.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/schema/cv_container_v3.md
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/schema/cv_device_v3.md
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/schema/cv_tag_v3.md
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down
6 changes: 6 additions & 0 deletions ansible_collections/arista/cvp/docs/schema/cv_validate_v3.md
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down
Loading
Loading