Document fixes for lint errors
howto/code/lint/index.rst
howto/code/lint/fix-errors
--------------------------
o Added a new 'fixing-errors' section in 'howto: lint'.
howto/code/lint/fix-errors/sphinx/spelling
howto/code/lint/fix-errors/yamllint
------------------------------------------
o Document a few known fixes for common problems.
requirements.txt
----------------
o Capture detail for a python upgrade error uncovered by 'make reload'.
o libdoc command for robot/robotframework having issues.
Change-Id: Iaa700327d374b6040841cbfc98f76ba95c16c799
Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 5a66739..b9bf768 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,13 +1,23 @@
---
# -----------------------------------------------------------------------
+# [NOTE] - Propogate .pre-commit-config.yaml edits to all repositories!
+# -----------------------------------------------------------------------
+# [TODO]
+# - pre-commit yaml config exists individually within repositories.
+# - Generally lint config and benavior is consistent for all repos.
+# - Exclusions and bulk cleanup necessitate per-repo custom configs.
+# - Dynamically generate this config file from common and custom
+# -----------------------------------------------------------------------
+
+# -----------------------------------------------------------------------
# Copyright 2024 Open Networking Foundation Contributors
#
# 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
+# 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,
@@ -21,39 +31,59 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
# -----------------------------------------------------------------------
-# .pre-commiit-config-yaml v0.1
+# .pre-commit-config-yaml 2024-04-10 v0.3
# -----------------------------------------------------------------------
+# ci:
+# skip: [sync]
+
repos:
-- repo: https://github.com/pre-commit/pre-commit-hooks
+ # Sync from repo
+ - repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files
-- repo: https://github.com/koalaman/shellcheck-precommit
+
+ - repo: https://github.com/koalaman/shellcheck-precommit
rev: v0.10.0
hooks:
- id: shellcheck
-- repo: https://github.com/adrienverge/yamllint.git
+
+ - repo: https://github.com/adrienverge/yamllint.git
rev: v1.35.1
hooks:
- id: yamllint
## -----------------------------------------------------------------------
+## [SOURCE] REUSE License Checking
+## -----------------------------------------------------------------------
+# - repo: https://github.com/ansys/pre-commit-hooks
+# rev: v0.2.9
+# hooks:
+# - id: add-license-headers
+# args:
+# - --custom_copyright=custom copyright phrase
+# - --custom_template=template_name
+# - --custom_license=license_name
+# - --ignore_license_check
+# - --start_year=2023
+
+## -----------------------------------------------------------------------
## [SOURCE] Python
## -----------------------------------------------------------------------
-# - repo: https://github.com/psf/black
-# rev: 22.10.0
-# hooks:
-# - id: black
+# - repo: https://github.com/psf/black
+# rev: 22.10.0
+# hooks:
+# - id: black
-# - repo: https://github.com/PyCQA/doc8
-# rev: v1.1.1
-# hooks:
-# - id: doc8
-
+# - repo: https://github.com/PyCQA/doc8
+# rev: v1.1.1
+# hooks:
+# - id: doc8
+
# -------------------------------------------------------------------
# https://docs.python.org/3/library/re.html#regular-expression-syntax
# -------------------------------------------------------------------
@@ -63,14 +93,14 @@
^makefiles/.* |
^lf/.* |
^.venv/.* |
+ ^jenkins-scripts/.* |
+ ^lf-ansible/.* |
+ ^packer/.* |
+ ^test/.* |
+ ^jjb/pipeline/voltha/voltha-physical-soak-dt-tests.groovy
)$
# [SEE ALSO]
# -----------------------------------------------------------------------
-# https://github.com/memfault/interrupt/blob/master/example/pre-commit/.pre-commit-config.yaml
-# https://pre-commit.com/hooks.html
-# https://github.com/floatingpurr/sync_with_poetry/blob/main/.pre-commit-config.yaml
-# https://github.com/the-common/pre-commit-config-template/blob/master/.pre-commit-config.yaml
-# -----------------------------------------------------------------------
# [EOF]