From 620f032ce0512755c29b572d7c93f451dfaa5ff5 Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Wed, 22 Jan 2020 17:28:00 -0500 Subject: Update Jenkins wiki -> plugins URLs The Jenkins Wiki page is deprecated and Jenkins community is expected to migrate their documentation to plugins.jenkins.io URL. This patch updates links that have a relevant plugins.jenkins.io URL documentation link. Change-Id: I7ce6978d48d09deea976e9b5f800632e92e7bd11 Signed-off-by: Thanh Ha --- jenkins_jobs/modules/metadata.py | 3 +- jenkins_jobs/modules/notifications.py | 5 ++- jenkins_jobs/modules/project_externaljob.py | 4 +- jenkins_jobs/modules/project_matrix.py | 14 +++---- jenkins_jobs/modules/project_maven.py | 4 +- jenkins_jobs/modules/project_multibranch.py | 65 +++++++++++++++-------------- jenkins_jobs/modules/project_pipeline.py | 2 +- jenkins_jobs/modules/project_workflow.py | 2 +- jenkins_jobs/modules/view_list.py | 2 +- jenkins_jobs/modules/view_pipeline.py | 5 ++- 10 files changed, 56 insertions(+), 50 deletions(-) diff --git a/jenkins_jobs/modules/metadata.py b/jenkins_jobs/modules/metadata.py index eb28ccd6..4c1fa2a2 100644 --- a/jenkins_jobs/modules/metadata.py +++ b/jenkins_jobs/modules/metadata.py @@ -16,7 +16,8 @@ """ The Metadata plugin module enables the ability to add metadata to the projects that can be exposed to job environment. -Requires the Jenkins :jenkins-wiki:`Metadata Plugin `. + +Requires the Jenkins :jenkins-plugins:`Metadata Plugin `. **Component**: metadata :Macro: metadata diff --git a/jenkins_jobs/modules/notifications.py b/jenkins_jobs/modules/notifications.py index f1f9407e..b9c7840e 100644 --- a/jenkins_jobs/modules/notifications.py +++ b/jenkins_jobs/modules/notifications.py @@ -33,8 +33,9 @@ import jenkins_jobs.modules.helpers as helpers def http_endpoint(registry, xml_parent, data): """yaml: http Defines an HTTP notification endpoint. - Requires the Jenkins :jenkins-wiki:`Notification Plugin - `. + + Requires the Jenkins :jenkins-plugins:`Notification Plugin + `. :arg str format: notification payload format, JSON (default) or XML :arg str event: job events that trigger notifications: started, diff --git a/jenkins_jobs/modules/project_externaljob.py b/jenkins_jobs/modules/project_externaljob.py index c6c7c490..969e3d65 100644 --- a/jenkins_jobs/modules/project_externaljob.py +++ b/jenkins_jobs/modules/project_externaljob.py @@ -22,8 +22,8 @@ This type of job allows you to record the execution of a process run outside Jenkins, even on a remote machine. This is designed so that you can use Jenkins as a dashboard of your existing automation system. -Requires the Jenkins :jenkins-wiki:`External Monitor Job Type Plugin -`. +Requires the Jenkins :jenkins-plugins:`External Monitor Job Type Plugin +`. Example: diff --git a/jenkins_jobs/modules/project_matrix.py b/jenkins_jobs/modules/project_matrix.py index f092279b..ebd566f5 100644 --- a/jenkins_jobs/modules/project_matrix.py +++ b/jenkins_jobs/modules/project_matrix.py @@ -25,17 +25,17 @@ internal YAML structure: * slave name or label (``slave``) * JDK name (``jdk``) -Requires the Jenkins :jenkins-wiki:`Matrix Project Plugin -`. +Requires the Jenkins :jenkins-plugins:`Matrix Project Plugin +`. The module also supports additional, plugin-defined axes: * DynamicAxis (``dynamic``), requires the Jenkins - :jenkins-wiki:`DynamicAxis Plugin ` + :jenkins-plugins:`DynamicAxis Plugin ` * GroovyAxis (``groovy``), requires the Jenkins :jenkins-wiki:`GroovyAxis Plugin ` * YamlAxis (``yaml``), requires the Jenkins - :jenkins-wiki:`Yaml Axis Plugin ` + :jenkins-plugins:`Yaml Axis Plugin ` To tie the parent job to a specific node, you should use ``node`` parameter. On a matrix project, this will tie *only* the parent job. To restrict axes @@ -56,7 +56,7 @@ jobs, you can define a single value ``slave`` axis. stable (default) or unstable * **yaml-strategy** (optional, requires - :jenkins-wiki:`Yaml Axis Plugin `): + :jenkins-plugins:`Yaml Axis Plugin `): * **exclude-key** (`str`) -- top key containing exclusion rules * Either one of: @@ -67,7 +67,7 @@ jobs, you can define a single value ``slave`` axis. * **axes** (`list`): * **axis**: * **type** (`str`) -- axis type, must be either type defined by - :jenkins-wiki:`Matrix Project Plugin ` + :jenkins-plugins:`Matrix Project Plugin ` (``label-expression``, ``user-defined``, ``slave`` or ``jdk``) or a type defined by a plugin (see top of this document for a list of supported plugins). @@ -80,7 +80,7 @@ Example: .. literalinclude:: /../../tests/general/fixtures/matrix-axis003.yaml -Requires the Jenkins :jenkins-wiki:`ShiningPanda Plugin `. +Requires the Jenkins :jenkins-plugins:`ShiningPanda Plugin `. Example: diff --git a/jenkins_jobs/modules/project_maven.py b/jenkins_jobs/modules/project_maven.py index 719b1d2d..91178598 100755 --- a/jenkins_jobs/modules/project_maven.py +++ b/jenkins_jobs/modules/project_maven.py @@ -70,8 +70,8 @@ in the :ref:`Job` definition. build succeeds ('SUCCESS'), build succeeds or is unstable ('UNSTABLE'), regardless of build result ('FAILURE'). (default 'FAILURE'). -Requires the Jenkins :jenkins-wiki:`Config File Provider Plugin -` +Requires the Jenkins :jenkins-plugins:`Config File Provider Plugin +` for the Config File Provider "settings" and "global-settings" config. Example: diff --git a/jenkins_jobs/modules/project_multibranch.py b/jenkins_jobs/modules/project_multibranch.py index 93c5bc38..93b5f380 100644 --- a/jenkins_jobs/modules/project_multibranch.py +++ b/jenkins_jobs/modules/project_multibranch.py @@ -26,11 +26,12 @@ which means that there is no guarantee that its behavior (or configuration) will not change, even between minor releases. Plugins required: - * :jenkins-wiki:`Workflow Plugin `. - * :jenkins-wiki:`Pipeline Multibranch Defaults Plugin - ` (optional) - * :jenkins-wiki:`Basic Branch Build Strategies Plugin - ` (optional) + +* :jenkins-plugins:`Workflow Plugin `. +* :jenkins-plugins:`Pipeline Multibranch Defaults Plugin + ` (optional) +* :jenkins-plugins:`Basic Branch Build Strategies Plugin + ` (optional) :Job Parameters: @@ -294,8 +295,8 @@ class WorkflowMultiBranchDefaults(WorkflowMultiBranch): def bitbucket_scm(xml_parent, data): r"""Configure BitBucket scm - Requires the :jenkins-wiki:`Bitbucket Branch Source Plugin - `. + Requires the :jenkins-plugins:`Bitbucket Branch Source Plugin + `. :arg str credentials-id: The credential to use to scan BitBucket. (required) @@ -307,8 +308,8 @@ def bitbucket_scm(xml_parent, data): (default false) :arg str server-url: The address of the bitbucket server. (optional) :arg str head-filter-regex: A regular expression for filtering - discovered source branches. Requires the :jenkins-wiki:`SCM API Plugin - `. + discovered source branches. Requires the :jenkins-plugins:`SCM API + Plugin `. :arg str discover-branch: Discovers branches on the repository. Valid options: ex-pr, only-pr, all. Value is not specified by default. @@ -338,14 +339,14 @@ def bitbucket_scm(xml_parent, data): be checked out to a local branch named master, and a remote branch origin/develop/new-feature will be checked out to a local branch named develop/newfeature. - Requires the :jenkins-wiki:`Git Plugin `. + Requires the :jenkins-plugins:`Git Plugin `. :arg dict checkout-over-ssh: Checkout repo over ssh. * **credentials** ('str'): Credentials to use for checkout of the repo over ssh. :arg dict filter-by-name-wildcard: Enable filter by name with wildcards. - Requires the :jenkins-wiki:`SCM API Plugin `. + Requires the :jenkins-plugins:`SCM API Plugin `. * **includes** ('str'): Space-separated list of name patterns to consider. You may use * as a wildcard; @@ -546,8 +547,8 @@ def bitbucket_scm(xml_parent, data): def gerrit_scm(xml_parent, data): """Configure Gerrit SCM - Requires the :jenkins-wiki:`Gerrit Code Review Plugin - `. + Requires the :jenkins-plugins:`Gerrit Code Review Plugin + `. :arg str url: The git url. (required) :arg str credentials-id: The credential to use to connect to the GIT URL. @@ -574,7 +575,7 @@ def gerrit_scm(xml_parent, data): the gerrit checks plugin. (optional) query-operator: Name of the query operator, supported values are: - 'SCHEME' or 'ID'. + 'SCHEME' or 'ID'. query-string: Value of the query operator. Minimal Example: @@ -660,7 +661,7 @@ def gerrit_scm(xml_parent, data): def git_scm(xml_parent, data): r"""Configure Git SCM - Requires the :jenkins-wiki:`Git Plugin `. + Requires the :jenkins-plugins:`Git Plugin `. :arg str url: The git repo url. (required) :arg str credentials-id: The credential to use to connect to the GIT repo. @@ -673,8 +674,8 @@ def git_scm(xml_parent, data): :arg bool ignore-on-push-notifications: If a job should not trigger upon push notifications. (default false) :arg str head-filter-regex: A regular expression for filtering - discovered source branches. Requires the :jenkins-wiki:`SCM API Plugin - `. + discovered source branches. Requires the :jenkins-plugins:`SCM API + Plugin `. :arg list build-strategies: Provides control over whether to build a branch (or branch like things such as change requests and tags) whenever it is discovered initially or a change from the previous revision has been @@ -777,8 +778,8 @@ def git_scm(xml_parent, data): def github_scm(xml_parent, data): r"""Configure GitHub SCM - Requires the :jenkins-wiki:`GitHub Branch Source Plugin - `. + Requires the :jenkins-plugins:`GitHub Branch Source Plugin + `. :arg str api-uri: The GitHub API uri for hosted / on-site GitHub. Must first be configured in Global Configuration. (default GitHub) @@ -813,8 +814,8 @@ def github_scm(xml_parent, data): Refer to :func:`~build_strategies `. :arg str notification-context: Change the default GitHub check notification context from "continuous-integration/jenkins/SUFFIX" to a custom text, - Requires the :jenkins-wiki:`Github Custom Notification Context SCM - Behaviour `. + Requires the :jenkins-plugins:`Github Custom Notification Context SCM + Behaviour `. :arg dict property-strategies: Provides control over how to build a branch (like to disable SCM triggering or to override the pipeline durability) (optional) @@ -1003,8 +1004,8 @@ def github_scm(xml_parent, data): def build_strategies(xml_parent, data): """Configure Basic Branch Build Strategies. - Requires the :jenkins-wiki:`Basic Branch Build Strategies Plugin - `. + Requires the :jenkins-plugins:`Basic Branch Build Strategies Plugin + `. :arg list build-strategies: Definition of build strategies. @@ -1176,7 +1177,7 @@ def build_strategies(xml_parent, data): def property_strategies(xml_parent, data): """Configure Basic Branch Property Strategies. - Requires the :jenkins-wiki:`Branch API Plugin `. + Requires the :jenkins-plugins:`Branch API Plugin `. :arg dict property-strategies: Definition of property strategies. Either `named-branches` or `all-branches` may be specified, but not both. @@ -1189,8 +1190,9 @@ def property_strategies(xml_parent, data): * **pipeline-branch-durability-override** (str): Set a custom branch speed/durability level. Valid values: performance-optimized, survivable-nonatomic, or - max-survivability (optional) Requires the :jenkins-wiki: - `Pipeline Multibranch Plugin ` + max-survivability (optional) + Requires the :jenkins-plugins:`Pipeline Multibranch Plugin + ` * **named-branches** (dict): Named branches get different properties. Comprised of a list of defaults and a list of property strategy @@ -1205,8 +1207,9 @@ def property_strategies(xml_parent, data): * **pipeline-branch-durability-override** (str): Set a custom branch speed/durability level. Valid values: performance-optimized, survivable-nonatomic, or - max-survivability (optional) Requires the :jenkins-wiki: - `Pipeline Multibranch Plugin ` + max-survivability (optional) + Requires the :jenkins-plugins:`Pipeline Multibranch Plugin + ` * **exceptions** (list): A list of branch names and the property strategies to be used on that branch, instead of any listed @@ -1223,9 +1226,9 @@ def property_strategies(xml_parent, data): * **pipeline-branch-durability-override** (str): Set a custom branch speed/durability level. Valid values: performance-optimized, survivable-nonatomic, or - max-survivability (optional) Requires the - :jenkins-wiki:`Pipeline Multibranch Plugin - ` + max-survivability (optional) + Requires the :jenkins-plugins:`Pipeline + Multibranch Plugin ` """ valid_prop_strats = ["all-branches", "named-branches"] diff --git a/jenkins_jobs/modules/project_pipeline.py b/jenkins_jobs/modules/project_pipeline.py index 3248c30d..518ba2c9 100644 --- a/jenkins_jobs/modules/project_pipeline.py +++ b/jenkins_jobs/modules/project_pipeline.py @@ -23,7 +23,7 @@ The Pipeline Project module handles creating Jenkins Pipeline projects You may specify ``pipeline`` in the ``project-type`` attribute of the :ref:`Job` definition. -Requires the Jenkins :jenkins-wiki:`Pipeline Plugin `: +Requires the Jenkins :jenkins-plugins:`Pipeline Plugin `. In order to write an inline script within a job-template you have to escape the curly braces by doubling them in the DSL: { -> {{ , otherwise it will be diff --git a/jenkins_jobs/modules/project_workflow.py b/jenkins_jobs/modules/project_workflow.py index 731f7257..35cd93b5 100644 --- a/jenkins_jobs/modules/project_workflow.py +++ b/jenkins_jobs/modules/project_workflow.py @@ -25,7 +25,7 @@ You may specify ``workflow`` in the ``project-type`` attribute of the :ref:`Job` definition. For now only inline scripts are supported. -Requires the Jenkins :jenkins-wiki:`Workflow Plugin `. +Requires the Jenkins :jenkins-plugins:`Workflow Plugin `. In order to use it for job-template you have to escape the curly braces by doubling them in the DSL: { -> {{ , otherwise it will be interpreted by the diff --git a/jenkins_jobs/modules/view_list.py b/jenkins_jobs/modules/view_list.py index 8ad7658c..5c1e1e5f 100644 --- a/jenkins_jobs/modules/view_list.py +++ b/jenkins_jobs/modules/view_list.py @@ -28,7 +28,7 @@ to the :ref:`view_list` definition. queue. (default false) * **job-name** (`list`): List of jobs to be included. * **job-filters** (`dict`): Job filters to be included. Requires - :jenkins-wiki:`View Job Filters ` + :jenkins-plugins:`View Job Filters ` * **most-recent** (`dict`) :most-recent: diff --git a/jenkins_jobs/modules/view_pipeline.py b/jenkins_jobs/modules/view_pipeline.py index 3ec25b10..a8b58ebc 100644 --- a/jenkins_jobs/modules/view_pipeline.py +++ b/jenkins_jobs/modules/view_pipeline.py @@ -16,8 +16,9 @@ The view pipeline module handles creating Jenkins Build Pipeline views. To create a pipeline view specify ``pipeline`` in the ``view-type`` attribute to the :ref:`view_pipeline` definition. -Requires the Jenkins -:jenkins-wiki:`Build Pipeline Plugin `. + +Requires the Jenkins :jenkins-plugins:`Build Pipeline Plugin +`. :View Parameters: * **name** (`str`): The name of the view. -- cgit