summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Adding view for the Delivery Pipeline PluginJiri Tyr2020-02-071-0/+7
| | | | | Change-Id: I8a9a71267562734b078b7260c79d299db7fb4e2b Signed-off-by: Jiri Tyr <jiri.tyr@gmail.com>
* Merge "Ignore py:obj warnings and fail on warnings"Zuul2020-02-071-0/+14
|\
| * Ignore py:obj warnings and fail on warningsThanh Ha2020-01-221-0/+14
| | | | | | | | | | | | | | | | * Enables fail on warnings and enable nitpicky * Consolidate string -> str for args Change-Id: Id5c29d48813fd6f772816dc74c7c4e408097113d Signed-off-by: Thanh Ha <zxiiro@gmail.com>
* | Fix some typos in documentationMattia Rizzolo2020-02-031-2/+2
|/ | | | | Change-Id: I67d82228bb37b8b4634c07e76a421964e227c3cb Signed-off-by: Mattia Rizzolo <mattia@mapreri.org>
* Fix links causing redirectsThanh Ha2020-01-222-3/+3
| | | | | | | | Some links have been permanently redirected to a new URL so adjust the links to go directly to the new URL. Change-Id: I900091f8bdc39aa5fd06eae04a9b18ef23add8f2 Signed-off-by: Thanh Ha <zxiiro@gmail.com>
* Update Jenkins wiki -> plugins URLsThanh Ha2020-01-221-2/+2
| | | | | | | | | | The Jenkins Wiki page is deprecated and Jenkins community is expected to migrate their documentation to plugins.jenkins.io URL. This patch updates all publishers that have a relevant plugins.jenkins.io URL documentation link. Change-Id: I94448d04f2b28fbf3befde2e49c76d196e352d7e Signed-off-by: Thanh Ha <zxiiro@gmail.com>
* Enable docs-linkcheckThanh Ha2020-01-062-3/+10
| | | | | | | | | This toxenv will allow us to flag URLs that no longer work. We also switch from using old style setup.py build_sphinx to the newer sphinx-build command. Change-Id: I62f42918814fb6eea4876e0d22c6bccddf86a826 Signed-off-by: Thanh Ha <zxiiro@gmail.com>
* Support nested viewsJan Zerebecki2019-10-241-0/+7
| | | | Change-Id: I13532a16efc6e970ab5a7c021ec4d77be98d3de8
* Auto-generated output from python-blackThanh Ha2019-09-091-26/+45
| | | | | | | | | Please review the following patch containing the code changes in the repo. This patch is a transition patch and is the auto-generated output of the python-black tool. Change-Id: I2d2de71da8a105fb62b561899ae78441ddab4032 Signed-off-by: Thanh Ha <zxiiro@gmail.com>
* Adds named branches to property strategy supportsbussetti2018-12-101-1/+1
| | | | | | | | | | | | | | | My previous submission added support for property strategy: all branches get the same properties. This patch adds support for the second of 2 options, "named branches get different properties", which allows for a default definition of properties + exceptions for individual refspecs based on their literal branch name. Also includes some re-org of the existing prop. strat. support in order to DRY up the code for both. Also adds sphinx.ext.doctest to docs/src/conf.py extensions to allow for running `make doctest` locally. Change-Id: Icd143fe25b1e2d5c8d1e7e8b0650d91f40838043 Signed-off-by: sbussetti <steve.bussetti@gmail.com>
* Adds support for Disable GitHub Multibranch Statussbussetti2018-11-011-1/+2
| | | | | | | | | | | Jenkins2 GitHub scms default to automatically sending updates on build status to github for pull requests. The plugin this enables allows control of this by enabling or disabling the feature via an SCM trait, allowing you to either no notify at all or manually notify via other means. Change-Id: I4f5629c3ee8031d41054e3be5e853201d8f0fed6 Signed-off-by: sbussetti <steve.bussetti@gmail.com>
* Add config options --jobs-only and --views-onlyAnil Belur2018-09-191-0/+5
| | | | | | | | | | | | | | | | | | | | | Add options --jobs-only and --views-only to job_builder section in config file. By default JJB updates both jobs and views. Some cases non-admin users are not allowed to update views on Jenkins which requires explicity using -j flag. Allow users to set a config option 'update=jobs|views|all' in the 'job_builder' section implicitly use --jobs-only or --views-only and control these flags from the config file. Note: CLI options takes precedence over the config file. Change-Id: I2a94e5a2d671ccbfc505de2f19b578ecfef9e9d7 Co-Authored-By: Thanh Ha <zxiiro@linux.com> Signed-off-by: Anil Belur <askb23@gmail.com> Signed-off-by: Thanh Ha <zxiiro@linux.com> Signed-off-by: Anil Belur <askb23@gmail.com>
* Document practical use case for variable defaultsThanh Ha2018-09-061-8/+137
| | | | | | | | | Took inspiration from my StackOverflow reply here https://stackoverflow.com/questions/50177308 to document a practical use of setting variable defaults and inheritenence. Change-Id: I45934341d3ff3fbf4ff711a435924197d2f12712 Signed-off-by: Thanh Ha <zxiiro@linux.com>
* adopt pre-commit hooksSorin Sbarnea2018-07-121-62/+65
| | | | | Change-Id: I98bc0b5717c3921b35e74f53c55f896427880a84 Signed-off-by: Sorin Sbarnea <ssbarnea@redhat.com>
* Normalize newlines at end of fileSorin Sbarnea2018-06-291-1/+0
| | | | | | | | Preparatory move for adopting pre-commit hooks. Shoudl only remove newlines and spaces at end of files. Change-Id: Ia33679467c533722b9308f7e7b74be395c926428 Signed-off-by: Sorin Sbarnea <ssbarnea@redhat.com>
* Add retain_anchors config option.Vicky Chijwani2018-05-311-0/+9
| | | | | | | | | If set to True, YAML anchors can be referenced across files, allowing jobs to be composed from bits of YAML defined in separate files. False by default. Story: 2000338 Task: 2547 Change-Id: I034ce3bce0030093cb8d4266dabbdb06d96306d6
* Merge "Add support for view-templates"Zuul2018-05-231-0/+27
|\
| * Add support for view-templatesThanh Ha2018-04-121-0/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Allow views to also be configured via templates similar to job-templates. This adds a new project key called "views" and parser type called "view-template" allowing the user to add custom views. Example: - view-template: name: '{name}-template-{seq}' description: 'testing view templates feature' view-type: list regex: 'test-view-.*' - project: name: 'test-view' views: - '{name}-template-{seq}' seq: - a - b - c Change-Id: I6eb225f24bc3c7d790c7dcab6391735c579ac71a Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
* | Fix a typo in docAnushka Bhandari2018-05-191-1/+1
| | | | | | | | | | | | | | Fix correct link to CloudBees Folders Plugin Add missing comma in line 1290 of module wrappers Change-Id: Idb0311064945965c58c0cc608fc6cab00eef3ee9
* | Merge "Document use of | character for variable defaults"Zuul2018-04-251-0/+10
|\ \
| * | Document use of | character for variable defaultsThanh Ha2018-04-131-0/+10
| |/ | | | | | | | | Change-Id: Id20fc7a49fef6684170a73834f2df06db3f0ca7f Signed-off-by: Thanh Ha <zxiiro@linux.com>
* / fix spelling errorsLuca Pierri2018-04-161-1/+1
|/ | | | Change-Id: I42b6bb46a9e5574f88ec5c0cb5726a65353a4fd7
* Add multibranch project-typeJoost van der Griendt2018-03-151-0/+7
| | | | | | | | | | | | | | | | | | | | | | | This work was based on original work done by Joshua Harlow on top of older code from: https://github.com/abnamrocoesd/jenkins-job-builder/ Credit is due to `Joost van der Griendt` for doing this work. This builds on his work in that repo, and adjusts it so that it can get merged into upstream and released as a fully supported job type. SCM implementation is different than than normal SCM module, supporting: BitBucket, git, and GitHub in this initial patch. Change-Id: If50a54d282dd7d901c16edb9fe04874bdd83c9ef Co-Authored-By: Joshua Harlow <jxharlow@godaddy.com> Co-Authored-By: Sorin Sbarnea <ssbarnea@redhat.com> Co-Authored-By: Thanh Ha <zxiiro@linux.com> Signed-off-by: Sorin Sbarnea <ssbarnea@redhat.com> Signed-off-by: Thanh Ha <zxiiro@linux.com> Signed-off-by: Sorin Sbarnea <ssbarnea@redhat.com>
* [Docs] Ensure commands are monospacedMajor Hayden2018-03-021-3/+2
| | | | | Change-Id: Iee9f8c8831ee83ea23677fdbdd20eb2ae7709d29 Signed-off-by: Major Hayden <major@mhtx.net>
* Merge "Add views and jobs only options for update"Zuul2018-02-231-0/+7
|\
| * Add views and jobs only options for updateAnil Belur2018-01-251-0/+7
| | | | | | | | | | | | | | | | | | | | JJB 2.0 update does not allow updating only views or jobs which would be useful, which is implemented with delete and delete-all. This patch add's thoses flags for the update option. Change-Id: I3712c8552ea83a4c29c05461894c4464aa41230f Signed-off-by: Anil Belur <askb23@gmail.com>
* | Merge "docs: sphinx upgrade and warnings as erros"Zuul2018-01-294-6/+6
|\ \
| * | docs: sphinx upgrade and warnings as errosSorin Sbarnea2018-01-264-6/+6
| | | | | | | | | | | | Change-Id: I455ac0d79cca3883d3a758a2709c8c0255f4cc7d
* | | Merge "Allow template-name in the global defaults"Zuul2018-01-271-0/+3
|\ \ \ | |/ / |/| |
| * | Allow template-name in the global defaultsJan Hruban2018-01-161-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | Inject the template-name into parameters earlier, so it's possible to use it in the global defaults. Mark the template name as 'verbatim' so the interpolation is skipped by the formatter. Change-Id: I5d98e32ed2bedaa6b536e61fbdec589f358f861f
* | | Merge "Added option to print job names as urls"Zuul2018-01-261-0/+5
|\ \ \
| * | | Added option to print job names as urlsSorin Sbarnea2018-01-261-0/+5
| | |/ | |/| | | | | | | | | | | | | | | | | | | Add print_job_urls = True to [job_builder] to enable output as urls instead of simple job names when changing them. Change-Id: I3454606a50ca385c87d8c13d3eab5d30d94cf02f Signed-off-by: Sorin Sbarnea <ssbarnea@redhat.com>
* / | Fix view definition documentationThanh Ha2018-01-172-0/+8
|/ / | | | | | | | | | | | | | | View documentation was not properly being generated and linked in the index. Let's add that in. Change-Id: I6197dbecc89ddcf8c6f6b0e6a3d4c517224dc77b Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
* | Merge "Add cloudbees folder creation support"Zuul2017-10-231-0/+7
|\ \
| * | Add cloudbees folder creation supportJerome Hourquebie2017-10-231-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | Add project folder module. Jenkins folder could be made with project-type: folder This requires Cloudbees folder plugin and python-jenkins folder update (see: https://review.openstack.org/#/c/180185/) Change-Id: I7e1c28c26a69ae6ca736cec88fcb957a716d8fad
* | | Basic folder supportDarragh Bailey2017-10-231-0/+29
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Allows specifying a folder attribute for each job generated, which in turn is used when creating or uploading to place the job under the requested folder. The job name is expanded after defaults are applied, to support the attribute being defined within a set of defaults applied to a number of jobs. This in turn allows for multiple jobs with the same basename to exist, provided they are targeted at different folders. Does not support creating the folders if they do not exist. Change-Id: I8c2157c4c81087cc972a048d1b88d5f08ac65361
* | Merge "Allow update to provide plugin_info via yaml"Jenkins2017-09-262-0/+31
|\ \
| * | Allow update to provide plugin_info via yamlThanh Ha2017-09-192-0/+31
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Getting plugin info requires Administrator permissions. It seems the test command allows providing the plugin_info details via a yaml configuration file. This patch allows the same command to be passed to the update command to allow us to configure the plugin versions manually and not require administrator permissions. Additionally this patch adds a new command called get-plugins-info which can create the plugins_info.yaml file to pass to the plugin_info_path. See: http://lists.openstack.org/pipermail/openstack-infra/2016-June/004388.html Change-Id: I5a34979407d863a84f34afbf8f565081ec52190a Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
* | | Document JJB 2.0 plugin config default behaviourThanh Ha2017-08-111-0/+7
|/ / | | | | | | | | | | | | | | | | | | | | Document the behaviour change in JJB 2.0 to default configuration to the latest supported version. These series of changes were modified via the topic:2.0-config-format in Gerrit. https://review.openstack.org/#/q/status:open+project:openstack-infra/jenkins-job-builder+branch:master+topic:2.0-config-format Change-Id: I96160bd63c39a1346f1eefd24eda475cfb30caf3 Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
* / Update Sphinx extlinks for new Jenkins domain nameDaniel Watkins2017-08-011-1/+1
|/ | | | | | | The Jenkins website, including the wiki subdomain, has moved from jenkins-ci.org to jenkins.io. Change-Id: Idd3eae89fdc2363979b4cf33903a0d09b6ae49ae
* Add option to make test output file layout match JenkinsPeter Eisentraut2017-05-271-0/+8
| | | | | | | | | | | | | | | | | | Before, `jenkins-job-builder test -o outdir` would write outdir/job_name With the new option `--config-xml`, it writes outdir/job_name/config.xml to match the layout that Jenkins uses internally. This is more useful for diffing against existing Jenkins installations or uploading job definitions by other means. Also, it seems better to give the output files an .xml extension. Change-Id: I78fc7aff531925ee071b8e19f40f766b4af0b5ad
* Add note regarding a bug with !include-raw-escapeThanh Ha2017-03-161-1/+1
| | | | | | | | This spawned from discussions on the mailing list: http://lists.openstack.org/pipermail/openstack-infra/2017-March/005233.html Change-Id: I7916ebec86350fa760bb02b6bde38e27c71dc359 Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
* Add Pipeline job type and deprecate WorkflowYann Voté2017-01-241-0/+7
| | | | | | | | | | | | | | | | | | | Since introduction of the Jenkins Pipeline plugin (https://wiki.jenkins-ci.org/display/JENKINS/Pipeline+Plugin), one can configure a Pipeline job using a Groovy file lying with the source code (see: https://jenkins.io/solutions/pipeline/). We add support here for this kind of jobs, introducing a new component: pipeline-scm. This component contains information about the repository to clone and the name of the file where the job configuration can be found. Since Workflow plugin is just an old name for the Pipeline plugin, Workflow job type can be deprecated in favor of Pipeline job type to avoid confusion and keep JJB in line with the terms used in Jenkins. Change-Id: I098b9673c44b1281fa0954193d8fadf273685386 Story: 2000573 Task: 2974
* Support default string values for variablesDarragh Bailey2016-11-111-4/+6
| | | | | | | | | | Provide syntax support for specifying default values to be substituted for variables during deep_format when no other replacement is provided. Allows for individual variables to have a default or be optionally blank should nothing be placed after the custom specifier. Change-Id: Ib97a33a2bbca123791d4ca6ef5248ed200992565
* Add view management functionalityThanh Ha2016-10-143-16/+53
| | | | | | | | | | | | | | | | | | | - Adds the ability for JJB to work with views - Views can be created, updated, and deleted. - New modules for List view and Build Pipeline view are added - New tests for testing the deletion of views Example View configuration: - view: name: MyView view-type: list Change-Id: Idb29a4407bcc14593e10a4d951036cb04e8e6c27 Co-Authored-By: Brandon Leonard <brandon.leonard@rackspace.com> Co-Authored-By: Joao Vale <jpvale@gmail.com> Co-Authored-By: Lucas Dutra Nunes <ldnunes@ossystems.com.br> Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
* Merge "Add comment about proxy env pass through"Jenkins2016-09-291-0/+9
|\
| * Add comment about proxy env pass throughDarragh Bailey2016-09-151-0/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | For users in a proxy environment, checking the doc urls requires being able to pass through the proxy environment variables. Include a simple comment along with the tox command requiring it to help users checking any links added are valid. Add some references to documentation, both in the detailed documentation and the quick README.rst that would be more commonly checked. Change-Id: I2316bc1b7e845c29a8b248eef4668a6099d109f7
* | Add Workflow Project DocumentationRyo Tagami2016-09-161-0/+7
|/ | | | | | | | | Even though the module for workflow project (a.k.a. pipeline project) is already there, documentation for it is missing. Add the index file to the doc tree to generate the documentation. Change-Id: I003d235867d58d12c7bcab83c54c7eca95d32ca9 Signed-off-by: Ryo Tagami <rtagami@airstrip.jp>
* Fix documentation of --delete-old: affects only managed jobs.Jonathan Perret2016-07-131-2/+3
| | | | | | | | | | | | | | | | As far back as its introduction (2cefa400), the `--delete-old` option has only ever deleted jobs that were marked with the special "<!-- Managed by Jenkins Job Builder -->" comment that JJB adds to descriptions. This change fixes the documentation of the `--delete-old` option, which erroneously used to state that even jobs that were never managed by JJB would be subject to deletion. The test for the feature was slightly enriched as well: the fact that unmanaged jobs were not deleted, was not actually tested. Change-Id: I438a7b555b6e122869988b3a2b9ea40896004122
* doc/definition.rst: add missing '/' into include pathAlexander Couzens2016-06-301-1/+1
| | | | Change-Id: If07710333cbb84ce70d6d4fa40602a74c898c08a
generated by cgit (git 2.34.1) at 2024-05-28 15:13:28 +0000