add description for CI_ROS2_REPOS_URL

ros2 · Dec 5, 2016 · 38f57f3 · 38f57f3
1 parent 0d63564
commit 38f57f3
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 2 deletions.
diff --git a/create_jenkins_job.py b/create_jenkins_job.py
@@ -37,6 +37,8 @@
 except ImportError:
     sys.exit("Could not import symbol from ros_buildfarm, please update ros_buildfarm.")
 
+from ros2_batch_job import DEFAULT_REPOS_URL
+
 template_prefix_path[:] = \
     [os.path.join(os.path.abspath(os.path.dirname(__file__)), 'job_templates')]
 
@@ -65,6 +67,7 @@ def main(argv=None):
     data = {
         'ci_scripts_repository': args.ci_scripts_repository,
         'ci_scripts_default_branch': args.ci_scripts_default_branch,
+        'default_repos_url': DEFAULT_REPOS_URL,
         'time_trigger_spec': '',
         'mailer_recipients': '',
         'use_connext_default': 'true',

diff --git a/job_templates/ci_job.xml.em b/job_templates/ci_job.xml.em
@@ -18,6 +18,7 @@
 @(SNIPPET(
     'property_parameter-definition',
     ci_scripts_default_branch=ci_scripts_default_branch,
+    default_repos_url=default_repos_url,
     use_connext_default=use_connext_default,
     disable_connext_static_default=disable_connext_static_default,
     disable_connext_dynamic_default=disable_connext_dynamic_default,

diff --git a/job_templates/ci_launcher_job.xml.em b/job_templates/ci_launcher_job.xml.em
@@ -16,6 +16,7 @@
 @(SNIPPET(
     'property_parameter-definition',
     ci_scripts_default_branch=ci_scripts_default_branch,
+    default_repos_url=default_repos_url,
     use_connext_default=use_connext_default,
     disable_connext_static_default=disable_connext_static_default,
     disable_connext_dynamic_default=disable_connext_dynamic_default,

diff --git a/job_templates/packaging_job.xml.em b/job_templates/packaging_job.xml.em
@@ -20,6 +20,7 @@
 @(SNIPPET(
     'property_parameter-definition_common',
     ci_scripts_default_branch=ci_scripts_default_branch,
+    default_repos_url=default_repos_url,
     cmake_build_type=cmake_build_type,
 ))@
         <hudson.model.ChoiceParameterDefinition>

diff --git a/job_templates/snippet/property_parameter-definition.xml.em b/job_templates/snippet/property_parameter-definition.xml.em
@@ -3,6 +3,7 @@
 @(SNIPPET(
     'property_parameter-definition_common',
     ci_scripts_default_branch=ci_scripts_default_branch,
+    default_repos_url=default_repos_url,
     cmake_build_type=cmake_build_type,
 ))@
         <hudson.model.BooleanParameterDefinition>

diff --git a/job_templates/snippet/property_parameter-definition_common.xml.em b/job_templates/snippet/property_parameter-definition_common.xml.em
@@ -15,7 +15,8 @@ To use the default branch on all repositories, use an empty string.</description
         </hudson.model.StringParameterDefinition>
         <hudson.model.StringParameterDefinition>
           <name>CI_ROS2_REPOS_URL</name>
-          <description></description>
+          <description>Custom .repos file to use instead of the default (@default_repos_url).
+For example, copy the content of the .repos file to a GitHub Gist, modify it to your needs, and then pass the raw URL here.</description>
           <defaultValue></defaultValue>
         </hudson.model.StringParameterDefinition>
         <hudson.model.ChoiceParameterDefinition>

diff --git a/ros2_batch_job/__init__.py b/ros2_batch_job/__init__.py
@@ -0,0 +1 @@
+DEFAULT_REPOS_URL = 'https://raw.githubusercontent.com/ros2/ros2/master/ros2.repos'
diff --git a/ros2_batch_job/__main__.py b/ros2_batch_job/__main__.py
@@ -31,6 +31,7 @@
      .format(osrf_pycommon.__file__, vendor_path))
 from osrf_pycommon.cli_utils.common import extract_argument_group
 
+from . import DEFAULT_REPOS_URL
 from .util import change_directory
 from .util import remove_folder
 from .util import force_color
@@ -67,7 +68,7 @@ def get_args(sysargv=None, skip_white_space_in=False, skip_connext=False, add_ro
         description="Builds the ROS2 repositories as a single batch job")
     parser.add_argument(
         '--repo-file-url',
-        default='https://raw.githubusercontent.com/ros2/ros2/master/ros2.repos',
+        default=DEFAULT_REPOS_URL,
         help="url of the ros2.repos file to fetch and use for the basis of the batch job")
     parser.add_argument(
         '--test-branch', default=None,