X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fbest-practices.rst;h=199422a631f90ca1938156c9c108d7b36c88b35e;hb=2c01d1c4b9b284118e2854494366e76d41e447f8;hp=2ea7ab936d113c1116a4dccf03cb2096141743ca;hpb=71937a20e010dfac85d9b4ffca73f7ec80066213;p=releng%2Fglobal-jjb.git diff --git a/docs/best-practices.rst b/docs/best-practices.rst index 2ea7ab93..199422a6 100644 --- a/docs/best-practices.rst +++ b/docs/best-practices.rst @@ -158,7 +158,6 @@ ship-logs example: - shell: !include-raw: - ../shell/logs-get-credentials.sh - shell: !include-raw: - - ../shell/lftools-install.sh - ../shell/logs-deploy.sh - shell: !include-raw: - ../shell/logs-clear-credentials.sh @@ -172,7 +171,7 @@ complete running via the logs-clear-credentials.sh script. This script contains 3 basic steps: 1. Provide credentials via config-file-provider -2. Run the build scripts in this case lftools-install.sh and logs-deploy.sh +2. Run logs-deploy.sh 3. Remove credentials provided by config-file-provider .. _preserve-variable-refs: @@ -182,7 +181,7 @@ Preserving Objects in Variable References JJB has an option to preserve a data structure object when you want to pass it to a template. -https://docs.openstack.org/infra/jenkins-job-builder/definition.html#variable-references +https://jenkins-job-builder.readthedocs.io/en/latest/definition.html#variable-references One thing that is not explicitly covered is the format of the variable name that you pass the object to. When you use the `{obj:key}` notation to preserve @@ -196,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 @@ -329,7 +328,7 @@ In this case there is a default '{message}' set in the If we do not declare a default in the :ref:`job-template ` then JJB will fallback to checking the "defaults configuration". -This means that the precendence of defaults is as follows: +This means that the precedence of defaults is as follows: 1. User-provided 2. Job Template @@ -372,7 +371,7 @@ Variable expansion order of precedence seems to be: global-jjb should not provide job-group definitions and leave it up to users of global-jjb to create their own as a job-group as a variable defined in a job -group the highest precendence. Global JJB should strive to be purely a +group the highest precedence. Global JJB should strive to be purely a job-template and macro library for downstream consumers. Final thoughts