[VOL-5297] Install module pre-commit for linting
Minor patch submitted for side effects.
Launch a 1c-1g AWS instance for debugging.
.pre-commit-config.yaml
-----------------------
o Update base pre-commit script config.
o Add doc8 and minor rst linting hooks.
howto/release/voltctl/release.rst
overview/contributing/copyright.rst
overview/contributing/patch_followup.rst
----------------------------------------
o Source edits and cleanups used to force a job run.
Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
Change-Id: Ie3243b953c6b6e9c0d31e0080b2ebbe1d2b91c0f
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index b9bf768..d764883 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -9,6 +9,9 @@
# - Exclusions and bulk cleanup necessitate per-repo custom configs.
# - Dynamically generate this config file from common and custom
# -----------------------------------------------------------------------
+# [HOOKS: disabled]
+# - reuse
+# -----------------------------------------------------------------------
# -----------------------------------------------------------------------
# Copyright 2024 Open Networking Foundation Contributors
@@ -60,9 +63,10 @@
## -----------------------------------------------------------------------
## [SOURCE] REUSE License Checking
## -----------------------------------------------------------------------
-# - repo: https://github.com/ansys/pre-commit-hooks
-# rev: v0.2.9
-# hooks:
+# - repo: https://github.com/fsfe/reuse-tool
+# rev: v3.0.2
+# hooks:
+# - id: reuse
# - id: add-license-headers
# args:
# - --custom_copyright=custom copyright phrase
@@ -74,15 +78,23 @@
## -----------------------------------------------------------------------
## [SOURCE] Python
## -----------------------------------------------------------------------
+
# - 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
+
+ - repo: https://github.com/pre-commit/pygrep-hooks
+ rev: v1.10.0
+ hooks:
+ - id: rst-backticks
+ - id: rst-directive-colons
+ - id: rst-inline-touching-normal
# -------------------------------------------------------------------
# https://docs.python.org/3/library/re.html#regular-expression-syntax
diff --git a/VERSION b/VERSION
index 9e71221..ea26801 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.12.39
+2.12.40
diff --git a/howto/release/voltctl/release.rst b/howto/release/voltctl/release.rst
index 09c8c26..d708f04 100644
--- a/howto/release/voltctl/release.rst
+++ b/howto/release/voltctl/release.rst
@@ -92,7 +92,7 @@
- Modify VERSION file major/minor numbers for the upcoming release.
- Remove any -dev or patch modifiers.
- Create a pull request for review.
- - Changes will be published when the jenkins job github-release-voltctl is run.
+ - Changes are published by pipeline job github-release-voltctl.
- Verify the release version contains a checksum file:
@@ -119,5 +119,6 @@
- Document key creation.
- Document github-release.sh command line and use.
+- Ignore this, cosmetic edit to force a job to run.
:ref:`voltctl-see-also`
diff --git a/overview/contributing/copyright.rst b/overview/contributing/copyright.rst
index c6caff8..05ef2a2 100644
--- a/overview/contributing/copyright.rst
+++ b/overview/contributing/copyright.rst
@@ -3,7 +3,7 @@
Include a copyright notice with all submissions to ONF repositoreis.
-- ``Copyright 2017-2023 Open Networking Foundation (ONF) and the ONF Contributors``
+- ``Copyright 2017-2023 Open Networking Foundation Contributors``
- NOTE: Range values such as -present are not legally binding
- Copyright notice should be dated to the last year sources were modified.
diff --git a/overview/contributing/patch_followup.rst b/overview/contributing/patch_followup.rst
index 3c9334f..f218b3d 100644
--- a/overview/contributing/patch_followup.rst
+++ b/overview/contributing/patch_followup.rst
@@ -124,7 +124,8 @@
- View all open/unmerged patches
- Scroll down through the list until something of interest is found.
- - Under the # column (2nd column on left hand side) right click and open to view the patch.
+ - Under the # column (2nd column on left hand side) right click and open
+ to view the patch.
- For example: `repo:voltha-system-tests <https://gerrit.opencord.org/c/voltha-system-tests/+/33380>`_
Patch history and jenkins jobs