Merge "Global JJB Disable generation of pip lists"

[releng/global-jjb.git] / docs / jjb / lf-release-jobs.rst

diff --git a/docs/jjb/lf-release-jobs.rst b/docs/jjb/lf-release-jobs.rst
index 8b5fa3d..cafab86 100644 (file)
--- a/docs/jjb/lf-release-jobs.rst
+++ b/docs/jjb/lf-release-jobs.rst
@@ -49,8 +49,7 @@ For example, the parameters for a Maven release are as follows::
 Maven Release Files
 -------------------
 
 Maven Release Files
 -------------------
 

-An example of a maven release file appears below. Name of release file
-must start with "maven". eg. releases/maven-1.0.0-test.yaml
+An example of a maven release file appears below.

 
 .. code-block:: none
 
 
 .. code-block:: none
 


@@ -181,16 +180,16 @@ PyPI Release Files
 ------------------
 
 An example of a PyPI release file appears below. Name of the release file must
 ------------------
 
 An example of a PyPI release file appears below. Name of the release file must

-start with "pypi". eg. releases/pypi-1.0.0-mypackage.yaml
+start with "pypi". For example releases/pypi-1.0.0-mypackage.yaml

 
 .. code-block:: none
 
     $ cat releases/pypi-1.0.0-mypackage.yaml
     ---
 
 .. code-block:: none
 
     $ cat releases/pypi-1.0.0-mypackage.yaml
     ---

-    distribution_type: pypi

     pypi_project: mypackage
     python_version: '3.4'
     version: 1.0.0
     pypi_project: mypackage
     python_version: '3.4'
     version: 1.0.0

+    log_dir: example-project-pypi-merge-master/17

 
 
 The following parameters must appear in the PyPI release yaml file.
 
 
 The following parameters must appear in the PyPI release yaml file.


@@ -200,7 +199,6 @@ packages.
 
 :Required Parameters:
 
 
 :Required Parameters:
 

-    :distribution_type: Must be "pypi".

     :log_dir: The suffix of the logs URL reported on completion by the
         Jenkins merge job that created and pushed the distribution files
         to the staging repository.  For example, use value
     :log_dir: The suffix of the logs URL reported on completion by the
         Jenkins merge job that created and pushed the distribution files
         to the staging repository.  For example, use value


@@ -223,15 +221,12 @@ The JSON schema for a PyPI release file appears below.
     $id: "https://github.com/lfit/releng-global-jjb/blob/master/release-pypi-schema.yaml"
 
     required:
     $id: "https://github.com/lfit/releng-global-jjb/blob/master/release-pypi-schema.yaml"
 
     required:

-      - "distribution_type"

       - "log_dir"
       - "pypi_project"
       - "python_version"
       - "version"
 
     properties:
       - "log_dir"
       - "pypi_project"
       - "python_version"
       - "version"
 
     properties:

-      distribution_type:
-        type: "string"

       log_dir:
         type: "string"
       pypi_project:
       log_dir:
         type: "string"
       pypi_project:


@@ -246,16 +241,15 @@ PackageCloud Release Files
 --------------------------
 
 An example of a PackageCloud release file appears below. Name of release file
 --------------------------
 
 An example of a PackageCloud release file appears below. Name of release file

-must start with "packagecloud". eg. releases/packagecloud-1.6.0-tree.yaml
+must start with "packagecloud". For example releases/packagecloud-1.6-tree.yaml

 
 .. code-block:: none
 
 
 .. code-block:: none
 

-    $ cat releases/packagecloud-1.6.0-tree.yaml
+    $ cat releases/packagecloud-1.6-tree.yaml

     ---
     ---

-    distribution_type: packagecloud

     package_name:
     package_name:

-        - name: 'tree-1.6.0-10.el7.x86_64.rpm'
-        - name: 'test.rpm'
+        - name: tree-1.6.0-10.el7.x86_64.rpm
+        - name: test.rpm

 
 The following parameters must appear in the PackageCloud release yaml file.
 These are not part of the Jenkins job definition to allow independent
 
 The following parameters must appear in the PackageCloud release yaml file.
 These are not part of the Jenkins job definition to allow independent


@@ -264,11 +258,10 @@ packages.
 
 :Required Parameters:
 
 
 :Required Parameters:
 

-    :distribution_type: Must be "packagecloud".

     :package_name: A list of names that specify the packages to promote.
     :package_name: A list of names that specify the packages to promote.

-        (Found via jenkins log when using gem to initally push package up eg.
+        (Found in jenkins console log when using gem to push package eg.

         "Pushing /path/of/package/name-of-package.rpm... success!"
         "Pushing /path/of/package/name-of-package.rpm... success!"

-        OR using rest api call with generated token from packagecloud.io
+        OR using rest api call to query packagecloud.io repo

         "curl https://packagecloud.io/api/v1/repos/test_user/test_repo/search?q=
         | yq -r .[].filename"
 
         "curl https://packagecloud.io/api/v1/repos/test_user/test_repo/search?q=
         | yq -r .[].filename"
 


@@ -282,7 +275,6 @@ The JSON schema for a PackageCloud release file appears below.
 
     required:
       - "package_name"
 
     required:
       - "package_name"

-      - "distribution_type"

 
     properties:
       package_name:
 
     properties:
       package_name:


@@ -290,8 +282,6 @@ The JSON schema for a PackageCloud release file appears below.
         properties:
           name:
             type: "string"
         properties:
           name:
             type: "string"

-    distribution_type:
-      type: "string"

 
 Jenkins Jobs
 ------------
 
 Jenkins Jobs
 ------------


@@ -390,7 +380,7 @@ This template supports Maven and Container release jobs.
         **default**::
 
             - compare-type: REG_EXP
         **default**::
 
             - compare-type: REG_EXP

-              pattern: '(releases\/maven.*\.yaml|\.releases\/maven.*\.yaml)'
+              pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)'

 
 
 PyPI Release Merge
 
 
 PyPI Release Merge