Chore!: Rename 'whitelist' to 'allowlist'

Improve global-jjb code and documentation to minimize
non-inclusivity.

Change-Id: I3c70ad4ad2c4d34510410b0baab439ab8681954d
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>

diff --git a/.jjb-test/defaults.yaml b/.jjb-test/defaults.yaml
index 781090c..b8c798e 100644 (file)
--- a/.jjb-test/defaults.yaml
+++ b/.jjb-test/defaults.yaml
@@ -17,7 +17,7 @@
     git-clone-url: "git@github.com:"
     github-org: example-org
     github-url: https://github.com/project
-    github_pr_whitelist:
+    github_pr_allowlist:
       - jpwku
       - tykeal
       - zxiiro

diff --git a/docs/_static/github-pr-trigger.example b/docs/_static/github-pr-trigger.example
index fbc3250..007718a 100644 (file)
--- a/docs/_static/github-pr-trigger.example
+++ b/docs/_static/github-pr-trigger.example
@@ -7,6 +7,6 @@
        github-hooks: true
        org-list:
          - '{github-org}'
-       white-list: '{obj:github_pr_whitelist}'
+       white-list: '{obj:github_pr_allowlist}'
        admin-list: '{obj:github_pr_admin_list}'
        included_regions: '{obj:github_included_regions}'

diff --git a/docs/best-practices.rst b/docs/best-practices.rst
index d2a1866..632bca3 100644 (file)
--- a/docs/best-practices.rst
+++ b/docs/best-practices.rst
@@ -195,7 +195,7 @@ Example:
 
    .. literalinclude:: _static/github-pr-trigger.example
 
-In the above example note the use of underscores in ``github_pr_whitelist``,
+In the above example note the use of underscores in ``github_pr_allowlist``,
 ``github_pr_admin_list``, and ``github_included_regions``.
 
 Using single quotes around variables

diff --git a/docs/configuration.rst b/docs/configuration.rst
index f7791d8..f238791 100644 (file)
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -51,7 +51,7 @@ values used by global-jjb templates.
 :github_pr_org: The name of the GitHub organization. All members
     of this organization will be able to trigger jobs.
 
-:github_pr_whitelist: List of GitHub members you wish to be able to
+:github_pr_allowlist: List of GitHub members you wish to be able to
     trigger jobs.
 
 :github_pr_admin_list: List of GitHub members that will have admin
@@ -81,7 +81,7 @@ Example GitHub Infra:
        # lf-infra defaults
        jenkins-ssh-credential: jenkins-ssh
        github-org: lfit
-       github_pr_whitelist:
+       github_pr_allowlist:
          - jpwku
          - tykeal
          - zxiiro

diff --git a/jjb/lf-ci-jobs.yaml b/jjb/lf-ci-jobs.yaml
index 36965c8..7759168 100644 (file)
--- a/jjb/lf-ci-jobs.yaml
+++ b/jjb/lf-ci-jobs.yaml
@@ -387,7 +387,7 @@
           github-hooks: true
           org-list:
             - "{github-org}"
-          white-list: "{obj:github_pr_whitelist}"
+          white-list: "{obj:github_pr_allowlist}"
           admin-list: "{obj:github_pr_admin_list}"
           included-regions: "{obj:github_included_regions}"
           white-list-target-branches:
@@ -814,7 +814,7 @@
           github-hooks: true
           org-list:
             - "{github-org}"
-          white-list: "{obj:github_pr_whitelist}"
+          white-list: "{obj:github_pr_allowlist}"
           admin-list: "{obj:github_pr_admin_list}"
           included-regions: "{obj:github_included_regions}"
           white-list-target-branches:
@@ -1616,7 +1616,7 @@
           github-hooks: true
           org-list:
             - "{github-org}"
-          white-list: "{obj:github_pr_whitelist}"
+          white-list: "{obj:github_pr_allowlist}"
           admin-list: "{obj:github_pr_admin_list}"
           # included-regions MUST match Gerrit Trigger file-paths
           included-regions:

diff --git a/jjb/lf-docker-jobs.yaml b/jjb/lf-docker-jobs.yaml
index 95bfa4b..411fe33 100644 (file)
--- a/jjb/lf-docker-jobs.yaml
+++ b/jjb/lf-docker-jobs.yaml
@@ -339,7 +339,7 @@
           github-hooks: true
           org-list:
             - "{github-org}"
-          white-list: "{obj:github_pr_whitelist}"
+          white-list: "{obj:github_pr_allowlist}"
           admin-list: "{obj:github_pr_admin_list}"
           white-list-target-branches:
             - "{branch}"

diff --git a/jjb/lf-maven-jobs.yaml b/jjb/lf-maven-jobs.yaml
index ea5f608..f491617 100644 (file)
--- a/jjb/lf-maven-jobs.yaml
+++ b/jjb/lf-maven-jobs.yaml
@@ -288,7 +288,7 @@
           github-hooks: true
           org-list:
             - "{github-org}"
-          white-list: "{obj:github_pr_whitelist}"
+          white-list: "{obj:github_pr_allowlist}"
           admin-list: "{obj:github_pr_admin_list}"
           white-list-target-branches:
             - "{branch}"
@@ -420,7 +420,7 @@
           github-hooks: true
           org-list:
             - "{github-org}"
-          white-list: "{obj:github_pr_whitelist}"
+          white-list: "{obj:github_pr_allowlist}"
           admin-list: "{obj:github_pr_admin_list}"
           white-list-target-branches:
             - "{branch}"
@@ -696,7 +696,7 @@
           github-hooks: true
           org-list:
             - "{github-org}"
-          white-list: "{obj:github_pr_whitelist}"
+          white-list: "{obj:github_pr_allowlist}"
           admin-list: "{obj:github_pr_admin_list}"
           white-list-target-branches:
             - "{branch}"
@@ -807,7 +807,7 @@
           github-hooks: true
           org-list:
             - "{github-org}"
-          white-list: "{obj:github_pr_whitelist}"
+          white-list: "{obj:github_pr_allowlist}"
           admin-list: "{obj:github_pr_admin_list}"
           white-list-target-branches:
             - "{branch}"
@@ -1440,7 +1440,7 @@
           github-hooks: true
           org-list:
             - "{github-org}"
-          white-list: "{obj:github_pr_whitelist}"
+          white-list: "{obj:github_pr_allowlist}"
           admin-list: "{obj:github_pr_admin_list}"
           white-list-target-branches:
             - "{branch}"
@@ -1480,7 +1480,7 @@
           github-hooks: true
           org-list:
             - "{github-org}"
-          white-list: "{obj:github_pr_whitelist}"
+          white-list: "{obj:github_pr_allowlist}"
           admin-list: "{obj:github_pr_admin_list}"
           white-list-target-branches:
             - "{branch}"

diff --git a/jjb/lf-python-jobs.yaml b/jjb/lf-python-jobs.yaml
index b21f0b2..6a40d17 100644 (file)
--- a/jjb/lf-python-jobs.yaml
+++ b/jjb/lf-python-jobs.yaml
@@ -817,7 +817,7 @@
           github-hooks: true
           org-list:
             - "{github-org}"
-          white-list: "{obj:github_pr_whitelist}"
+          white-list: "{obj:github_pr_allowlist}"
           admin-list: "{obj:github_pr_admin_list}"
           white-list-target-branches:
             - "{branch}"
@@ -1069,7 +1069,7 @@
           github-hooks: true
           org-list:
             - "{github-org}"
-          white-list: "{obj:github_pr_whitelist}"
+          white-list: "{obj:github_pr_allowlist}"
           admin-list: "{obj:github_pr_admin_list}"
           white-list-target-branches:
             - "{branch}"

diff --git a/jjb/lf-rtd-jobs.yaml b/jjb/lf-rtd-jobs.yaml
index 9c8e945..0a757e8 100644 (file)
--- a/jjb/lf-rtd-jobs.yaml
+++ b/jjb/lf-rtd-jobs.yaml
@@ -138,7 +138,7 @@
           github-hooks: true
           org-list:
             - "{github-org}"
-          white-list: "{obj:github_pr_whitelist}"
+          white-list: "{obj:github_pr_allowlist}"
           admin-list: "{obj:github_pr_admin_list}"
           included-regions: "{obj:github_included_regions}"
           white-list-target-branches:

diff --git a/releasenotes/notes/minimuze-non-inclusive-language-d323e7a8eb807ea7.yaml b/releasenotes/notes/minimuze-non-inclusive-language-d323e7a8eb807ea7.yaml
new file mode 100644 (file)
index 0000000..2af5430
--- /dev/null
+++ b/releasenotes/notes/minimuze-non-inclusive-language-d323e7a8eb807ea7.yaml
@@ -0,0 +1,8 @@
+---
+prelude: >
+  Improve global-jjb code and documentation to minimize non-inclusivity.
+
+  https://developers.google.com/style/inclusive-documentation
+other:
+  - |
+    Rename 'whitelist' to 'allowlist'