From dc652542673fa6bea4b2bd37ed3a1049af47b650 Mon Sep 17 00:00:00 2001 From: Anil Belur Date: Fri, 1 Jul 2022 14:04:16 +1000 Subject: [PATCH] Chore: Fix tox verify - Rm all acumos resources on the infra is decomissioned. - Rm Nexus fd.io is decommissioned. - Update pre-commit deps gitlint v4.0.1 -> v4.3.0. black v0.15.1 -> v0.17.0. flake8 updating 21.9b0 -> 22.6.0. bandit 1.7.0 -> 1.7.4. write-good v1.0.4 -> v1.0.8. - Reword docs to address write-good warnings - Set default language to 'en' Fixes the following Sphinx warning (treated as error) starting with 5.0 release: Warning, treated as error: Invalid configuration value found: 'language = None'. Update your configuration to a valid langauge code. Falling back to 'en' (English). Signed-off-by: Anil Belur Change-Id: I838a8743ab556906b01112ad6805bc92c1fc3161 --- .pre-commit-config.yaml | 10 +++++----- docs/ansible.rst | 4 ++-- docs/conf.py | 1 - docs/conf.yaml | 1 + docs/gerrit.rst | 5 ++--- docs/git.rst | 2 +- docs/infra/inventory.rst | 17 +---------------- docs/infra/openstack.rst | 6 +++--- docs/jenkins.rst | 9 ++++----- 9 files changed, 19 insertions(+), 36 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 5b417e8..c2e60fe 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,7 +4,7 @@ default_language_version: repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.0.1 + rev: v4.3.0 hooks: - id: check-executables-have-shebangs - id: check-merge-conflict @@ -12,12 +12,12 @@ repos: - id: trailing-whitespace - repo: https://github.com/jorisroovers/gitlint - rev: v0.15.1 + rev: v0.17.0 hooks: - id: gitlint - repo: https://github.com/ambv/black - rev: 21.9b0 + rev: 22.6.0 hooks: - id: black @@ -28,7 +28,7 @@ repos: args: ["--max-line-length=88"] - repo: https://github.com/pycqa/bandit - rev: 1.7.0 + rev: 1.7.4 hooks: - id: bandit # Bandit does not need to run on test code @@ -41,7 +41,7 @@ repos: - repo: https://github.com/btford/write-good - rev: v1.0.4 + rev: v1.0.8 hooks: - id: write-good files: "\\.(rst|md|markdown|mdown|mkdn)$" diff --git a/docs/ansible.rst b/docs/ansible.rst index 648470c..8dc05d0 100644 --- a/docs/ansible.rst +++ b/docs/ansible.rst @@ -59,8 +59,8 @@ Set up an Ansible Role .. note:: The ``ansible-galaxy`` command creates a directory named ROLE_NAME so - call it from outside of the repo directory and pass it the name of the - repo. + call it from outside the repo directory and pass it the name of the + repository. #. Change directory into the ROLE_NAME directory #. Create a .gitignore:: diff --git a/docs/conf.py b/docs/conf.py index 22d781b..3fdfe10 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,6 @@ intersphinx_mapping["ansible"] = ( # noqa linkcheck_ignore = [ "https://gerrit.linuxfoundation.org/infra/releng/docs-conf", "https://gerrit.linuxfoundation.org/infra/#/settings/http-password", - "https://jenkins.acumos.org.*", "https://build.automotivelinux.org.*", "https://build.automotivelinux.org/sandbox", "https://.*.example.org.*", diff --git a/docs/conf.yaml b/docs/conf.yaml index 5e69cb7..01ec466 100644 --- a/docs/conf.yaml +++ b/docs/conf.yaml @@ -1,2 +1,3 @@ --- project_cfg: lfdocs +language: 'en' diff --git a/docs/gerrit.rst b/docs/gerrit.rst index 558f517..49707fe 100644 --- a/docs/gerrit.rst +++ b/docs/gerrit.rst @@ -458,9 +458,8 @@ If the change it's a draft, you'll need to publish it. Do this from the Gerrit w Remove your -1 vote if you've marked it with one. If you think the patch is ready for merge, vote +1. If there is not an automated job to test your change and vote +1/-1 for Verified, you will need to do as much testing yourself as possible and then manually -vote +1 to Verified. You can also vote +1 for Verified if you have done testing in -addition to any automated tests. Describing the testing you did or did not do is -typically helpful. +vote +1 to Verified. Reviewers can dditionally vote +1 for Verified along with +automated jobs. Describing the testing you did or did not do is typically helpful. .. figure:: _static/gerrit-voting-interface.png diff --git a/docs/git.rst b/docs/git.rst index f8752dc..e91f240 100644 --- a/docs/git.rst +++ b/docs/git.rst @@ -406,7 +406,7 @@ How to manage a big script, by submitting smaller patches which are depending on #. Next patch - Add the code for the next patch - - Submit it as per `Workflow Sample 1`_ (from Correct the patch step) + - Submit it according to `Workflow Sample 1`_ (from Correct the patch step) Remember to do 'git commit --signoff --gpg-sign --verbose', to submit a new patch. diff --git a/docs/infra/inventory.rst b/docs/infra/inventory.rst index eef6817..9d413c2 100644 --- a/docs/infra/inventory.rst +++ b/docs/infra/inventory.rst @@ -19,21 +19,6 @@ Inventory - Insight Dashboard - Stats - * - Acumos - - | https://gerrit.acumos.org - | https://github.com/acumos - - | https://jenkins.acumos.org - | https://jenkins.acumos.org/sandbox - - https://jira.acumos.org - - | https://nexus.acumos.org - | https://nexus3.acumos.org - - https://logs.acumos.org - - | https://wiki.acumos.org - | https://docs.acumos.org - - https://sonarcloud.io/organizations/acumos/projects - - https://insights.lfx.linuxfoundation.org/projects/lfai%2Facumos/dashboard - - `Acumos Jenkins `_ - * - AGL - | https://gerrit.automotivelinux.org | https://github.com/automotive-grade-linux @@ -106,7 +91,7 @@ Inventory - | https://jenkins.fd.io | https://jenkins.fd.io/sandbox - https://jira.fd.io - - https://nexus.fd.io + - N/A - https://logs.fd.io - | https://wiki.fd.io | https://fd.io/documentation diff --git a/docs/infra/openstack.rst b/docs/infra/openstack.rst index eb0551c..cd552c4 100644 --- a/docs/infra/openstack.rst +++ b/docs/infra/openstack.rst @@ -4,9 +4,9 @@ OpenStack Management #################### -We use OpenStack as our primary underlying cloud for CI. With the majority of -the projects all hosted with the same vendor we can adopt common management -practices across them. +We use OpenStack as our primary underlying cloud for CI. Most LF +projects hosted with the same vendor enables us to adopt common +management practices across them. Sharing instance images ======================= diff --git a/docs/jenkins.rst b/docs/jenkins.rst index f7e8f6f..2b4bace 100644 --- a/docs/jenkins.rst +++ b/docs/jenkins.rst @@ -189,7 +189,6 @@ Build agents flavors This section points to each LF project's build agents availability and flavors. -* Acumos: https://github.com/acumos/ci-management/tree/master/jenkins-config/clouds/openstack/ACUMOSVEX * Akraino: https://github.com/akraino-edge-stack/ci-management/tree/master/jenkins-config/clouds/openstack/cattle * EdgeX Foundry: https://github.com/edgexfoundry/ci-management/tree/master/jenkins-config/clouds/openstack/Primary * FD.io: https://github.com/FDio/ci-management/tree/master/jenkins-config/clouds @@ -228,8 +227,8 @@ Configuration of credentials for production Jenkins systems come from the Configuration of credentials for sandbox Jenkins systems come from the ??CredentialMappings.sandbox.yaml file. -The config_type will correspond to the type that is under management as per how -JCasC itself defines the file type. +The config_type will correspond to the type that is under management +is how JCasC itself defines the file type. Common types in the LF environment are: @@ -569,8 +568,8 @@ directly to test the behavior. The Jenkins Sandbox can contain dummy configuration files and dummy credentials in case it helps take the test further and not fail on the first steps due to the configuration -not being present. Any attempt to actually use the configuration files in order -to make any server communications will fail. To add dummy configuration files, please +not being present. Any attempt to use the configuration files will cause the server +communications to fail. To add dummy configuration files, please create a new ticket to :ref:`Helpdesk `. In such case, merge jobs, push, CLM, Docker or Sonar jobs get tested to some extent due -- 2.16.6