23e6f39287
There are cases when you want SSH Agent plugin to just start and stop an SSH agent during the build, without adding any keys automatically. One of such cases is when you want to use an SSH key stored on a SmartCard -like device, such as NitroKey HSM. So far, when the "users" property was set to an empty list then the output XML markup didn't contain the <credentialIds/> tag and the plugin was then crashing with NullPointerException. Also, when the "users" property was set to a list with just one value then the output XML markup was always generated in the "old style" format (matching plugin versions < 1.5, so like almost 8 years old). With this change, when using the "users" property the markup is generated based on the actual plugin version installed in Jenkins. More importantly, the generated markup is now properly handled by the plugin, no matter if the input is an empty list or a list with one or more entries. Finally, fixed the parent of the <ignoreMissing> tag, which was wrongly put under <credentialIds> tag when generating the "new style" markup (1.5+), while it should simply be a top-level tag, laying next to <credentialIds>, as in the corresponding implementation class [1]. This means the "ignore-missing-credentials" property was broken when the "users" property was set to a list with more than one entry and it's now fixed. [1] https://github.com/jenkinsci/ssh-agent-plugin/blob/ssh-agent-1.5/src/main/java/com/cloudbees/jenkins/plugins/sshagent/SSHAgentBuildWrapper.java#L83 Change-Id: Ife5a08739da9ea1130f0ea7daa08c16675f6c75d
README
Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML or JSON format and uses them to configure Jenkins. You can keep your job descriptions in human readable text format in a version control system to make changes and auditing easier. It also has a flexible template system, so creating many similarly configured jobs is easy.
To install:
$ pip install --user jenkins-job-builderOnline documentation:
Developers
Bug report:
Repository:
Cloning:
git clone https://opendev.org/jjb/jenkins-job-builder.gitInstall pre-commit from https://pre-commit.com/#intro in order to run some minimal testing on your commits.
A virtual environment is recommended for development. For example, Jenkins Job Builder may be installed from the top level directory:
$ virtualenv .venv
$ source .venv/bin/activate
$ pip install -r test-requirements.txt -e .Patches are submitted via Gerrit at:
Please do not submit GitHub pull requests, they will be automatically closed.
Mailing list:
IRC:
#openstack-jjbon OFTC
More details on how you can contribute is available on our wiki at:
Writing a patch
We ask that all code submissions be pep8 and pyflakes clean. The easiest
way to do that is to run tox before submitting
code for review in Gerrit. It will run pep8 and
pyflakes in the same manner as the automated test suite
that will run on proposed patchsets.
When creating new YAML components, please observe the following style conventions:
- All YAML identifiers (including component names and arguments) should be lower-case and multiple word identifiers should use hyphens. E.g., "build-trigger".
- The Python functions that implement components should have the same name as the YAML keyword, but should use underscores instead of hyphens. E.g., "build_trigger".
This consistency will help users avoid simple mistakes when writing YAML, as well as developers when matching YAML components to Python implementation.
Unit Tests
Unit tests have been included and are in the tests
folder. Many unit tests samples are included as examples in our
documentation to ensure that examples are kept current with existing
behaviour. To run the unit tests, execute the command:
tox -e py34,py27- Note: View
tox.inito run tests on other versions of Python, generating the documentation and additionally for any special notes on running the test to validate documentation external URLs from behind proxies.
Installing without setup.py
For YAML support, you will need libyaml installed.
Mac OS X:
$ brew install libyamlThen install the required python packages using pip:
$ sudo pip install PyYAML python-jenkins