Code Review
/
releng
/
global-jjb.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Chore: Comment recent tox.ini changes
[releng/global-jjb.git]
/
docs
/
best-practices.rst
diff --git
a/docs/best-practices.rst
b/docs/best-practices.rst
index
2ea7ab9
..
199422a
100644
(file)
--- 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: !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
- ../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
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:
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.
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
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
.. literalinclude:: _static/github-pr-trigger.example
-In the above example note the use of underscores in ``github_pr_
white
list``,
+In the above example note the use of underscores in ``github_pr_
allow
list``,
``github_pr_admin_list``, and ``github_included_regions``.
Using single quotes around variables
``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 <job-template>` then
JJB will fallback to checking the "defaults configuration".
If we do not declare a default in the :ref:`job-template <job-template>` then
JJB will fallback to checking the "defaults configuration".
-This means that the prece
n
dence of defaults is as follows:
+This means that the precedence of defaults is as follows:
1. User-provided
2. Job Template
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
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 prece
n
dence. 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
job-template and macro library for downstream consumers.
Final thoughts