summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* doc change: remove duplicate general job parametersKhai Do2014-11-111-86/+2
| | | | | | | | | This change adds a test to validate the general job parameters and uses that test as documentation for the general module. It also replaces the doc of the general params in the top level definitions.rst with references to the general module. Change-Id: I3df04d69186ca49d7297f8141855a4c72c73be1e
* Add documentation for logrotate job parameterKhai Do2014-10-301-0/+9
| | | | | Change-Id: I33217503ff5935c6592dfb262a0e672577505d61 Closes-Bug: #1376913
* Merge "Add documentation and example on the usage of yaml anchors and aliases."Jenkins2014-10-291-3/+12
|\
| * Add documentation and example on the usage of yaml anchors and aliases.Khai Do2014-10-231-3/+12
| | | | | | | | Change-Id: I9227820cfdccace2d8a463529da64041c156e8ec
* | Merge "Add additional documentation for passing objects to templates"Jenkins2014-10-291-1/+3
|\|
| * Add additional documentation for passing objects to templatesKhai Do2014-10-231-1/+3
| | | | | | | | | | | | | | | | I noticed that users were not really aware of how this feature worked so added additional documentation for it. Change-Id: Ic5385ae859295cdd015d698ede3da4988efd9ca7 Closes-Bug: 1335945
* | Merge "Cleaning up index.rst file"Jenkins2014-10-291-5/+0
|\ \
| * | Cleaning up index.rst fileChristian Berendt2014-07-211-5/+0
| | | | | | | | | | | | | | | | | | Removed notes about the generation of the file. Change-Id: I7330ee5f97a6751164d7ec978c64a4dfb92ead15
* | | Merge "Added description for node attribute in documentation."Jenkins2014-10-231-0/+7
|\ \ \ | |_|/ |/| |
| * | Added description for node attribute in documentation.Denis Kochetkov2014-10-221-0/+7
| | | | | | | | | | | | | | | | | | The "node" attribute of Job allows to specify labels of Jenkins builders where the job can be executed. Change-Id: Icb2a72a3d6340b1f9d9bdcc27e2e9691b1752c24
* | | add a JJB command referenceKhai Do2014-10-211-4/+8
| | | | | | | | | | | | | | | | | | | | | | | | I've noticed that people don't necessarily know about the sub options in JJB so adding a command referencing showing all command options will hopefully help. Change-Id: Id0f786077e1e5a35db5ab45e0e2c3760ac11ded0
* | | Merge "add documentation for globbed parameter feature"Jenkins2014-10-211-0/+13
|\ \ \
| * | | add documentation for globbed parameter featureKhai Do2014-10-211-0/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | change I5bb1074 added a globbed parameter feature for updating and deleting JJB jobs but did not provide documentation for it. Hopefully this change will help users discover this feature. Change-Id: I6e527c818f25a5aa061a19308f22495221e3dc93
* | | | Merge "add documentation for the delete command"Jenkins2014-10-211-2/+25
|\| | |
| * | | add documentation for the delete commandKhai Do2014-10-211-2/+25
| | | | | | | | | | | | | | | | Change-Id: Iaa84c66aab01bf404ad64e960578a913254b21e4
* | | | Fix command to build docs in installation documentationDavid Pursehouse2014-10-211-1/+1
|/ / / | | | | | | | | | | | | | | | | | | Change I1ad04bd renamed the `doc` environment to `docs` but did not update the documentation. Change-Id: I63cb324f222a40e91b21cc0d3b569b6352bf88b3
* / / Accept list of paths in 'path' arg.Wayne2014-10-171-0/+13
|/ / | | | | | | | | | | | | | | | | | | | | | | This adds the behavior of splitting the path positional argument on colons then processing each resulting string the same way that the path was being processed previous to this commit. * Adds a unit test to validate correct `path` parsing. * Adds a unit test to validate correct `path` parsing in the recursive case. * Documents the new behavior. Change-Id: I0f465e02077569352cd276a8366ead5bab0eb117
* | Error on duplicate job names being foundDarragh Bailey2014-09-301-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When parsing yaml files, any duplicate macros, job-templates, job-groups or jobs should be considered an error by default, but provide a config option for this to be ignored. Need to check for seen jobs twice, when processing job groups listed under projects and again the jobs have been generated from templates. Use a set and store each job name generated and check on the next iteration. Finally walk the list of generated jobs and check if any duplicates are encountered. Also ensure that if the user wishes for duplicates to be ignored that the last defined job replaces the earlier one. Change-Id: Id31ef33ae1b2469f7c3eeabe77420377978fa35e
* | Merge "Added recursive option"Jenkins2014-09-221-0/+4
|\ \
| * | Added recursive optionDavid Caro2014-08-291-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Now you can organize your yaml files into subdirectories and apply them all just passing --recursive option or adding the proper configuration file option. In adding support for multiple paths the Builder.load_files method was reworked to be backward compatible with individual paths or file-like objects, while also now handling being passed a list of paths or file-like objects to be parsed. Change-Id: I126751e347622716c592c6ed1a57b8acb7bf79a4
* | | Apply defaults to job-templates parametersAntoine Musso2014-08-221-0/+8
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I had the use case of a lot of projects sharing the same job template that uses a lot of variables. That requires each project to define all the variables even if they are mostly identical. This patch propose to define varialbes as 'defaults' and have them applied in the job-template magically (oneline diffs always have that feeling to me). So instead of: - project: name: project1 arch: amd64 builder: debuild lintian: true jobs: - '{name}-build-{arch}' And so on ... I can just: - defaults: name: sanebuild - project: name: project1 defaults: sanebuild jobs: - '{name}-build-{arch}' And override the arch as needed either in the project or by passing it to the job. Without this patch, the provided yamlparser fixture template_honor_defaults.yaml would raise: arch parameter missing to format echo Build arch {arch}. Given: {'': '', 'jobs': ['build-{arch}'], 'name': 'project-name'} Change-Id: Ida1e27eb47356d9cae42175743bd2fd52eb9d869
* | Clarify configuration and job definitionKhai Do2014-08-023-12/+12
| | | | | | | | | | | | | | | | | | The docs was a little confusing in that used a single term 'configuration' to referred to both the JJB global configuration and the job definitions. This change clarifies that by changing 'configuration' in a few places to 'job definition' to make it less confusing. Change-Id: Ie64e7d899b793c9c8e86e51076c020640e336a40
* | Replace 'Testing JJB' with the term 'Test Mode'Khai Do2014-08-021-9/+11
| | | | | | | | | | | | | | | | | | | | | | The term 'testing' is overloaded. I thought it meant running the actual JJB tests instead of running the JJB application. I think a good way to distinguish the two is to use the term 'test mode' when it's in the context of running the JJB application with the 'test' parameter. I've already been using the term 'run in test mode' quite a bit in my JJB reviews to distiguish it from the actual JJB tests. Change-Id: I2076189e3ae55caa20d0894fb20859a7c461e46a
* | Revert "Allow using template variables in "defaults" field."Antoine Musso2014-07-241-5/+0
|/ | | | | | | | | | | | | | This reverts commit 70ed22362a9c13ea9f3165e5747dcca281ad439c. I knew I should have tested the patch with my own templates. Doing so I discovered a nasty regression: The defaults can make use of variables passed by the project. By moving applyDEfaults to be called after deep_format is performed on job templates, any substitutioncontained withing defaults is no longer correctly replaced by project parameters. Change-Id: I69ffb3e28093af6db62962786d9275bf3ba4e115
* Merge "Allow using template variables in "defaults" field."Jenkins2014-07-071-0/+5
|\
| * Allow using template variables in "defaults" field.Joao Vale2014-06-271-0/+5
| | | | | | | | Change-Id: I876ab7fa61258e84b00a67325aeb9234aff8fa62
* | Merge "removed job configuration duplication in docs"Jenkins2014-06-272-136/+58
|\ \
| * | removed job configuration duplication in docsKhai Do2014-06-052-136/+58
| | | | | | | | | | | | | | | | | | | | | The same job definition and examples were in both general.rst and configuration.rst. Moved the contents of general to configuration. Change-Id: Iefdf1b6ac3b9679a8af4451710442bf58054d790
* | | Merge "Fix a broken include in the configuration documentation."Jenkins2014-06-251-1/+1
|\ \ \
| * | | Fix a broken include in the configuration documentation.Florian Preinstorfer2014-06-181-1/+1
| | |/ | |/| | | | | | | Change-Id: I803caea42365e44851068e510d5e698447aad73b
* / | Use yaml local tags to support including filesDarragh Bailey2014-06-202-0/+11
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add support for local tags which are application specific to allow including of other yaml files or code from scripts. Allows for code to be maintained and tested as seperate files, as well as reduces duplication of yaml code that cannot be macro'ed or easily templated by including it from a common file. Adds support for the following tags: 'include' - load file as yaml code 'include-raw' - load file as data (for scripts) 'include-raw-escaped' - load file as data with escaping braces '{}' as default for use with job-templates Use configuration file options to provide a search path for the files. - Test behaviour of yaml tags independent of any XML generation by comparing json result of yaml parsing to verify that certain tags do/don't recall the yaml.load() method. - Add examples for the include tags via addition tests for YamlParser class Inspired by http://stackoverflow.com/questions/528281/how-can-i-include-an-yaml-file-inside-another Change-Id: Ib90a07043112d4739d6529ceddbc9817668bcec0
* | Merge "re-arrange docs for clarity"Jenkins2014-06-121-6/+11
|\ \
| * | re-arrange docs for clarityzaro05082014-06-061-6/+11
| |/ | | | | | | | | | | | | | | The info on using list and dict as parameters seemed a little too advanced to be in the description of 'templates'. This change moves this example into a newly created 'advanced' configuration section. Change-Id: I98b80233c45ac721819360743dcae5e82c63ecbf
* | Merge "remove misleading jjb example"Jenkins2014-06-111-33/+14
|\ \
| * | remove misleading jjb exampleKhai Do2014-06-061-33/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Change I059f38d0aa8a8947aaac75e0ddb34d392063ece3 added support for passing parameters to jobs in groups but not for variable substitution on those parameters. Substitution on job list parameters would be a new feature. This change removes a misleading parameter subsitution example. Partial-bug: #1298568 Change-Id: I18e28bb622f0473f049963ce6dcf6c4efd11dc2c
* | | Merge "Support variable-specific substitutions in templates."Jenkins2014-06-111-0/+6
|\ \ \ | |_|/ |/| |
| * | Support variable-specific substitutions in templates.Joao Vale2014-05-121-0/+6
| | | | | | | | | | | | Change-Id: I6af84f48eaa4ee44c8d8babddd8d10a1e1095101
* | | Merge "update URL references to project."Jenkins2014-06-041-1/+1
|\ \ \ | |_|/ |/| |
| * | update URL references to project.Khai Do2014-05-221-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | github.com/openstack-ci was moved to github.com/openstack-infra homepage references should point to git.o.o/cgit/openstack-infra This change updates the above references accordingly. Change-Id: I4d3591f228b10de050a129ae7af99485f50edab5
* | | Add tox "coverage" targetMarc Abramowitz2014-05-271-0/+7
| |/ |/| | | | | Change-Id: I577d62e016a550ea30671837a0a426165984e982
* | Test creation of multiple jobs from templatesDarragh Bailey2014-05-101-23/+1
|/ | | | | | | | | | Concatenate each job XML created from the parsed yaml when using the YamlParser class for testing. Ensures that multiple jobs created from a single yaml file can be tested. Remove erroneous multiple job from scm_remote_deep_bug test. Change-Id: I2732a7303fefff1f321a1a5b7eef9144d168e39a
* Merge "Added config options to not overwrite jobs desc"Jenkins2014-04-211-3/+15
|\
| * Added config options to not overwrite jobs descDavid Caro2014-04-091-3/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When you do not specify any description for a job, right now it creates a new one overwriting whatever you had put there manually. Now when setting the configuration option 'keep_descriptions' to True, it will only overwrite the description if you specified one explicitly in the yaml. That way you can avoid specifying any description and it will not overwrite the ones you put there manually through the jenkins ui. Added a couple of tests for it also, and extended the tests to allow custom configuration by adding a *.conf file for it Change-Id: I408f5ee06a6939a8cb8f4f2e6c6e0d060462259c Signed-off-by: David Caro <dcaroest@redhat.com>
* | `test` command read/write stdin/stdout by defaultMarc Abramowitz2014-04-181-0/+5
| | | | | | | | | | | | | | | | | | | | E.g.: jenkins-jobs test < config/jenkins.yml This is convenient for demoing or implementing functional tests. Change-Id: I4e3030e261d3b90f75e4a033ea074d18764d97bf
* | Merge "add ability to parse from a file object"Jenkins2014-04-141-0/+8
|\ \ | |/ |/|
| * add ability to parse from a file objectAlexandre Conrad2014-04-131-0/+8
| | | | | | | | Change-Id: I4f62fad4d2c0e361eddaed6d4db2faa655bd4b11
* | Minor fixes in the installation documentationDavid Pursehouse2014-04-081-5/+6
| | | | | | | | | | | | | | Fix a couple of grammatical errors, and wrap long lines to fit within 80 columns. Change-Id: Ide46f5fdc6bb2f0b759fc6e69669097d23149791
* | Merge "Small documentation tweaks"Jenkins2014-04-071-19/+16
|\ \
| * | Small documentation tweaksMarc Abramowitz2014-04-041-19/+16
| |/ | | | | | | Change-Id: I00ed518141b60dfa1c22a11edc391532bf49a0a1
* | Merge "use {obj:key} as a way to pass an object and not only strings to ↵Jenkins2014-04-041-0/+6
|\ \ | | | | | | | | | templates"