Move debian-specific release templates to a subdirectory (#717)

Each of these templates includes a debian-specific approach that doesn't
apply to RPMs. The templates remaining in the `templates/release`
directory don't appear to be debian-specific and should be usable for
RPMs as well.

In some locations (such as `release_job.py`) it will be necessary to
select a template based on the packaging format of the target OS.
Organizing the templates in subdirectories like this will give us an
easy way to select the template that serves a specific purpose for a
given packaging format. This is why some of the template file names were
also renamed to be more neutral.

Author: cottsay

doc/jobs/release_call_graph.dot

@@ -18,30 +18,30 @@ digraph {
 	scripts__release__trigger_jobs [label="scripts/release/trigger_jobs.py"]
 
 	# release templates
-	templates__release__binarydeb_create_task__Dockerfile [label="templates/release/binarydeb_create_task.Dockerfile.em"]
-	templates__release__binarydeb_install_task__Dockerfile [label="templates/release/binarydeb_install_task.Dockerfile.em"]
-	templates__release__binarydeb_job__xml [label="templates/release/binarydeb_job.xml.em"]
-	templates__release__binarydeb_task__Dockerfile [label="templates/release/binarydeb_task.Dockerfile.em"]
+	templates__release__deb__binarypkg_create_task__Dockerfile [label="templates/release/deb/binarypkg_create_task.Dockerfile.em"]
+	templates__release__deb__binarypkg_install_task__Dockerfile [label="templates/release/deb/binarypkg_install_task.Dockerfile.em"]
+	templates__release__deb__binarypkg_job__xml [label="templates/release/deb/binarypkg_job.xml.em"]
+	templates__release__deb__binarypkg_task__Dockerfile [label="templates/release/deb/binarypkg_task.Dockerfile.em"]
+	templates__release__deb__sourcepkg_job__xml [label="templates/release/deb/sourcepkg_job.xml.em"]
+	templates__release__deb__sourcepkg_task__Dockerfile [label="templates/release/deb/sourcepkg_task.Dockerfile.em"]
 	templates__release__release_create_reconfigure_task__Dockerfile [label="templates/release/release_create_reconfigure_task.Dockerfile.em"]
 	templates__release__release_create_trigger_task__Dockerfile [label="templates/release/release_create_trigger_task.Dockerfile.em"]
 	templates__release__release_reconfigure_jobs_job__xml [label="templates/release/release_reconfigure-jobs_job.xml.em"]
 	templates__release__release_script__sh [label="templates/release/release_script.sh.em"]
 	templates__release__release_trigger_jobs_job__xml [label="templates/release/release_trigger-jobs_job.xml.em"]
-	templates__release__sourcedeb_job__xml [label="templates/release/sourcedeb_job.xml.em"]
-	templates__release__sourcedeb_task__Dockerfile [label="templates/release/sourcedeb_task.Dockerfile.em"]
 
 	# templates
-	templates__release__binarydeb_create_task__Dockerfile,
-	templates__release__binarydeb_install_task__Dockerfile,
-	templates__release__binarydeb_job__xml,
-	templates__release__binarydeb_task__Dockerfile,
+	templates__release__deb__binarypkg_create_task__Dockerfile,
+	templates__release__deb__binarypkg_install_task__Dockerfile,
+	templates__release__deb__binarypkg_job__xml,
+	templates__release__deb__binarypkg_task__Dockerfile,
+	templates__release__deb__sourcepkg_job__xml,
+	templates__release__deb__sourcepkg_task__Dockerfile,
 	templates__release__release_create_reconfigure_task__Dockerfile,
 	templates__release__release_create_trigger_task__Dockerfile,
 	templates__release__release_reconfigure_jobs_job__xml,
 	templates__release__release_script__sh,
-	templates__release__release_trigger_jobs_job__xml,
-	templates__release__sourcedeb_job__xml,
-	templates__release__sourcedeb_task__Dockerfile
+	templates__release__release_trigger_jobs_job__xml
 		[color="gray"]
 
 	# run in Docker container
@@ -58,10 +58,10 @@ digraph {
 		[shape="octagon"]
 
 	# Jenkins job templates
-	templates__release__binarydeb_job__xml,
+	templates__release__deb__binarypkg_job__xml,
+	templates__release__deb__sourcepkg_job__xml,
 	templates__release__release_reconfigure_jobs_job__xml,
-	templates__release__release_trigger_jobs_job__xml,
-	templates__release__sourcedeb_job__xml
+	templates__release__release_trigger_jobs_job__xml
 		[fontcolor="blue"]
 
 	# entry points
@@ -88,54 +88,54 @@ digraph {
 	templates__release__release_create_trigger_task__Dockerfile -> scripts__release__trigger_jobs [weight="2"]
 
 	scripts__release__generate_release_jobs -> scripts__release__generate_release_job [fontcolor="gray", label=" ∀ source pkgs", weight="2"]
-	scripts__release__generate_release_job -> templates__release__sourcedeb_job__xml [fontcolor="gray", label="∀ OS code names"]
-	scripts__release__generate_release_job -> templates__release__binarydeb_job__xml [fontcolor="gray", label=" ∀ OS code names\nand arches", weight="2"]
+	scripts__release__generate_release_job -> templates__release__deb__sourcepkg_job__xml [fontcolor="gray", label="∀ OS code names"]
+	scripts__release__generate_release_job -> templates__release__deb__binarypkg_job__xml [fontcolor="gray", label=" ∀ OS code names\nand arches", weight="2"]
 	{
 		rank=same
-		templates__release__sourcedeb_job__xml -> templates__release__binarydeb_job__xml [style=invis]
+		templates__release__deb__sourcepkg_job__xml -> templates__release__deb__binarypkg_job__xml [style=invis]
 	}
 
 	# sourcedeb branch
-	templates__release__sourcedeb_job__xml -> scripts__release__run_sourcedeb_job
-	scripts__release__run_sourcedeb_job -> templates__release__sourcedeb_task__Dockerfile [fontcolor="gray", label="generate"]
-	templates__release__sourcedeb_job__xml:se -> templates__release__sourcedeb_task__Dockerfile:ne [fontcolor="gray", label="build & run", weight="2"]
-	templates__release__sourcedeb_task__Dockerfile -> scripts__release__get_sources
-	templates__release__sourcedeb_task__Dockerfile -> scripts__release__build_sourcedeb
+	templates__release__deb__sourcepkg_job__xml -> scripts__release__run_sourcedeb_job
+	scripts__release__run_sourcedeb_job -> templates__release__deb__sourcepkg_task__Dockerfile [fontcolor="gray", label="generate"]
+	templates__release__deb__sourcepkg_job__xml:se -> templates__release__deb__sourcepkg_task__Dockerfile:ne [fontcolor="gray", label="build & run", weight="2"]
+	templates__release__deb__sourcepkg_task__Dockerfile -> scripts__release__get_sources
+	templates__release__deb__sourcepkg_task__Dockerfile -> scripts__release__build_sourcedeb
 	{
 		rank=same
 		scripts__release__get_sources -> scripts__release__build_sourcedeb [style=invis]
 	}
 
 	# binarydeb branch
-	templates__release__binarydeb_job__xml -> scripts__release__run_binarydeb_job [weight="2"]
-	scripts__release__run_binarydeb_job -> templates__release__binarydeb_create_task__Dockerfile [fontcolor="gray", label=" generate", weight="2"]
+	templates__release__deb__binarypkg_job__xml -> scripts__release__run_binarydeb_job [weight="2"]
+	scripts__release__run_binarydeb_job -> templates__release__deb__binarypkg_create_task__Dockerfile [fontcolor="gray", label=" generate", weight="2"]
 
-	templates__release__binarydeb_job__xml -> templates__release__binarydeb_create_task__Dockerfile [fontcolor="gray", label="build & run"]
-	templates__release__binarydeb_create_task__Dockerfile -> scripts__release__get_sourcedeb
-	templates__release__binarydeb_create_task__Dockerfile -> scripts__release__append_build_timestamp [fontcolor="gray", xlabel="optional "]
-	templates__release__binarydeb_create_task__Dockerfile -> scripts__release__create_binarydeb_task_generator [fontcolor="gray", xlabel="needs deps from\n.dsc file"]
+	templates__release__deb__binarypkg_job__xml -> templates__release__deb__binarypkg_create_task__Dockerfile [fontcolor="gray", label="build & run"]
+	templates__release__deb__binarypkg_create_task__Dockerfile -> scripts__release__get_sourcedeb
+	templates__release__deb__binarypkg_create_task__Dockerfile -> scripts__release__append_build_timestamp [fontcolor="gray", xlabel="optional "]
+	templates__release__deb__binarypkg_create_task__Dockerfile -> scripts__release__create_binarydeb_task_generator [fontcolor="gray", xlabel="needs deps from\n.dsc file"]
 	{
 		rank=same
 		scripts__release__build_sourcedeb -> scripts__release__get_sourcedeb [style=invis]
 		scripts__release__get_sourcedeb -> scripts__release__append_build_timestamp -> scripts__release__create_binarydeb_task_generator [style=invis]
 	}
-	scripts__release__create_binarydeb_task_generator -> templates__release__binarydeb_task__Dockerfile [constraint=false, fontcolor="gray", label="generate"]
-	templates__release__binarydeb_job__xml -> templates__release__binarydeb_task__Dockerfile [fontcolor="gray", label="build & run"]
-	templates__release__binarydeb_task__Dockerfile -> scripts__release__build_binarydeb
+	scripts__release__create_binarydeb_task_generator -> templates__release__deb__binarypkg_task__Dockerfile [constraint=false, fontcolor="gray", label="generate"]
+	templates__release__deb__binarypkg_job__xml -> templates__release__deb__binarypkg_task__Dockerfile [fontcolor="gray", label="build & run"]
+	templates__release__deb__binarypkg_task__Dockerfile -> scripts__release__build_binarydeb
 
 	# install task
-	templates__release__binarydeb_job__xml -> scripts__release__create_binarydeb_install_task_generator
+	templates__release__deb__binarypkg_job__xml -> scripts__release__create_binarydeb_install_task_generator
 	{
 		rank=same
-		templates__release__binarydeb_create_task__Dockerfile -> templates__release__binarydeb_task__Dockerfile -> scripts__release__create_binarydeb_install_task_generator [style=invis]
+		templates__release__deb__binarypkg_create_task__Dockerfile -> templates__release__deb__binarypkg_task__Dockerfile -> scripts__release__create_binarydeb_install_task_generator [style=invis]
 	}
-	scripts__release__create_binarydeb_install_task_generator -> templates__release__binarydeb_install_task__Dockerfile [fontcolor="gray", label="generate"]
-	templates__release__binarydeb_job__xml:e -> templates__release__binarydeb_install_task__Dockerfile [fontcolor="gray", label="build & run"]
+	scripts__release__create_binarydeb_install_task_generator -> templates__release__deb__binarypkg_install_task__Dockerfile [fontcolor="gray", label="generate"]
+	templates__release__deb__binarypkg_job__xml:e -> templates__release__deb__binarypkg_install_task__Dockerfile [fontcolor="gray", label="build & run"]
 
 	# release script
 	scripts__release__generate_release_script -> templates__release__release_script__sh [weight="2"]
-	templates__release__release_script__sh -> templates__release__sourcedeb_job__xml [weight="2"]
-	templates__release__release_script__sh -> templates__release__binarydeb_job__xml [weight="0"]
+	templates__release__release_script__sh -> templates__release__deb__sourcepkg_job__xml [weight="2"]
+	templates__release__release_script__sh -> templates__release__deb__binarypkg_job__xml [weight="0"]
 	{
 		rank=same
 		scripts__release__generate_release_script -> scripts__release__generate_release_jobs [style=invis]

doc/jobs/release_call_graph.png

@@ -575,7 +575,7 @@ def _get_sourcedeb_job_config(
         config, build_file, os_name, os_code_name,
         pkg_name, repo_name, release_repository, dist_cache=None,
         is_disabled=False, other_build_files_same_platform=None):
-    template_name = 'release/sourcedeb_job.xml.em'
+    template_name = 'release/deb/sourcepkg_job.xml.em'
 
     repository_args, script_generating_key_files = \
         get_repositories_and_script_generating_key_files(build_file=build_file)
@@ -658,7 +658,7 @@ def _get_binarydeb_job_config(
         pkg_name, repo_name, release_repository,
         dist_cache=None, upstream_job_names=None,
         is_disabled=False):
-    template_name = 'release/binarydeb_job.xml.em'
+    template_name = 'release/deb/binarypkg_job.xml.em'
 
     repository_args, script_generating_key_files = \
         get_repositories_and_script_generating_key_files(build_file=build_file)
@@ -761,7 +761,7 @@ def get_import_package_job_name(rosdistro_name):
 
 
 def _get_import_package_job_config(build_file):
-    template_name = 'release/import_package_job.xml.em'
+    template_name = 'release/deb/import_package_job.xml.em'
     job_data = {
         'target_queue': build_file.target_queue,
         'abi_incompatibility_assumed': build_file.abi_incompatibility_assumed,
@@ -806,7 +806,7 @@ def get_sync_packages_to_testing_job_name(
 def _get_sync_packages_to_testing_job_config(
         config_url, rosdistro_name, release_build_name, os_code_name, arch,
         config, build_file):
-    template_name = 'release/sync_packages_to_testing_job.xml.em'
+    template_name = 'release/deb/sync_packages_to_testing_job.xml.em'
 
     repository_args, script_generating_key_files = \
         get_repositories_and_script_generating_key_files(build_file=build_file)
@@ -859,7 +859,7 @@ def get_sync_packages_to_main_job_name(rosdistro_name):
 
 
 def _get_sync_packages_to_main_job_config(rosdistro_name, build_file):
-    template_name = 'release/sync_packages_to_main_job.xml.em'
+    template_name = 'release/deb/sync_packages_to_main_job.xml.em'
     job_data = {
         'rosdistro_name': rosdistro_name,
 

ros_buildfarm/release_job.py

@@ -53,7 +53,7 @@ def main(argv=sys.argv[1:]):
             args.distribution_repository_key_files),
     }
     create_dockerfile(
-        'release/binarydeb_install_task.Dockerfile.em',
+        'release/deb/binarypkg_install_task.Dockerfile.em',
         data, args.dockerfile_dir)
 
     # output hints about necessary volumes to mount

ros_buildfarm/templates/release/binarydeb_create_task.Dockerfile.em ros_buildfarm/templates/release/deb/binarypkg_create_task.Dockerfile.em

@@ -108,7 +108,7 @@ def main(argv=sys.argv[1:]):
         'binarypkg_dir': args.binarypkg_dir,
     }
     create_dockerfile(
-        'release/binarydeb_task.Dockerfile.em', data, args.dockerfile_dir)
+        'release/deb/binarypkg_task.Dockerfile.em', data, args.dockerfile_dir)
 
     # output hints about necessary volumes to mount
     ros_buildfarm_basepath = os.path.normpath(

ros_buildfarm/templates/release/binarydeb_install_task.Dockerfile.em ros_buildfarm/templates/release/deb/binarypkg_install_task.Dockerfile.em

@@ -116,7 +116,7 @@ def get_trigger_missed_jobs_job_config(args, config, build_file):
 
 
 def get_import_upstream_job_config(args, config, build_file):
-    template_name = 'release/import_upstream_job.xml.em'
+    template_name = 'release/deb/import_upstream_job.xml.em'
     return _get_job_config(args, config, config.notify_emails, template_name)
 
 

ros_buildfarm/templates/release/binarydeb_job.xml.em ros_buildfarm/templates/release/deb/binarypkg_job.xml.em

@@ -57,7 +57,7 @@ def __init__(self):
 
         def beforeFile(self, *args, **kwargs):
             template_path = kwargs['file'].name
-            if template_path.endswith('/release/binarydeb_job.xml.em'):
+            if template_path.endswith('/release/deb/binarypkg_job.xml.em'):
                 self.scripts.append('--')
 
         def beforeInclude(self, *args, **kwargs):

ros_buildfarm/templates/release/binarydeb_task.Dockerfile.em ros_buildfarm/templates/release/deb/binarypkg_task.Dockerfile.em

@@ -74,7 +74,7 @@ def main(argv=sys.argv[1:]):
         'dockerfile_dir': '/tmp/docker_build_binarydeb',
     })
     create_dockerfile(
-        'release/binarydeb_create_task.Dockerfile.em',
+        'release/deb/binarypkg_create_task.Dockerfile.em',
         data, args.dockerfile_dir)
 
 

ros_buildfarm/templates/release/import_package_job.xml.em ros_buildfarm/templates/release/deb/import_package_job.xml.em

@@ -62,7 +62,7 @@ def main(argv=sys.argv[1:]):
         'uid': get_user_id(),
     })
     create_dockerfile(
-        'release/sourcedeb_task.Dockerfile.em', data, args.dockerfile_dir)
+        'release/deb/sourcepkg_task.Dockerfile.em', data, args.dockerfile_dir)
 
 
 if __name__ == '__main__':