X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-release-jobs.rst;h=8b5fa3d9bafdd9eecb7b89ad5926dd4b8b2ceb91;hb=9ce5ef214927e657dbd0d7cf6ed1ad613d642055;hp=e124f8cf49e96bc543a9524e5b9b59e69a8e7cff;hpb=e313cb04f2c7255dcc5429c16afd391d62db1ff7;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-release-jobs.rst b/docs/jjb/lf-release-jobs.rst index e124f8cf..8b5fa3d9 100644 --- a/docs/jjb/lf-release-jobs.rst +++ b/docs/jjb/lf-release-jobs.rst @@ -49,7 +49,8 @@ For example, the parameters for a Maven release are as follows:: Maven Release Files ------------------- -An example of a maven release file appears below. +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 .. code-block:: none @@ -179,11 +180,12 @@ The JSON schema for a container release file appears below. PyPI Release Files ------------------ -An example of a PyPI release file appears below. +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 .. code-block:: none - $ cat releases/pypi-release.yaml + $ cat releases/pypi-1.0.0-mypackage.yaml --- distribution_type: pypi pypi_project: mypackage @@ -208,7 +210,7 @@ packages. release repositories, for example "mypackage". :python_version: The Python interpreter version to use for pip "Requires-Python" compatibility checks, for example '3', '3.7' or 3.7.4. - Valid decimal values such as 3 and 3.7 must be quoted. + Put valid decimal values such as 3 or 3.7 in quotes to pass schema validation. :version: The semantic version string used for the package in the setup.py file. @@ -240,6 +242,57 @@ The JSON schema for a PyPI release file appears below. type: "string" +PackageCloud Release Files +-------------------------- + +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 + +.. code-block:: none + + $ cat releases/packagecloud-1.6.0-tree.yaml + --- + distribution_type: packagecloud + package_name: + - 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 +self-release of a package maintained in a git repository with other +packages. + +:Required Parameters: + + :distribution_type: Must be "packagecloud". + :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. + "Pushing /path/of/package/name-of-package.rpm... success!" + OR using rest api call with generated token from packagecloud.io + "curl https://packagecloud.io/api/v1/repos/test_user/test_repo/search?q= + | yq -r .[].filename" + +The JSON schema for a PackageCloud release file appears below. + +.. code-block:: none + + --- + $schema: "http://json-schema.org/schema#" + $id: "https://github.com/lfit/releng-global-jjb/blob/master/packagecloud-release-schema" + + required: + - "package_name" + - "distribution_type" + + properties: + package_name: + type: "array" + properties: + name: + type: "string" + distribution_type: + type: "string" + Jenkins Jobs ------------ @@ -337,7 +390,7 @@ This template supports Maven and Container release jobs. **default**:: - compare-type: REG_EXP - pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)' + pattern: '(releases\/maven.*\.yaml|\.releases\/maven.*\.yaml)' PyPI Release Merge @@ -378,6 +431,12 @@ template accepts neither a branch nor a stream parameter. should be the repository pypy.org. (default: pypi) :use-release-file: Whether to use the release file. (default: true) + :gerrit_trigger_file_paths: Override file paths filter which checks which + file modifications will trigger a build. + **default**:: + + - compare-type: REG_EXP + pattern: '(releases\/pypi.*\.yaml|\.releases\/pypi.*\.yaml)' PyPI Release Verify ~~~~~~~~~~~~~~~~~~~ @@ -416,6 +475,77 @@ verify template accepts neither a branch nor a stream parameter. should be the repository pypy.org (default: pypi) :use-release-file: Whether to use the release file. (default: true) + :gerrit_trigger_file_paths: Override file paths filter which checks which + file modifications will trigger a build. + **default**:: + + - compare-type: REG_EXP + pattern: '(releases\/pypi.*\.yaml|\.releases\/pypi.*\.yaml)' + +PackageCloud Release Verify +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This template supports PackageCloud release jobs. + +:Template Name: {project-name}-packagecloud-release-verify + +:Comment Trigger: recheck|reverify + +:Required Parameters: + + :build-node: The node to run build on. + :jenkins-ssh-credential: Credential to use for SSH. (Generally set + in defaults.yaml) + :project: Git repository name + :project-name: Jenkins job name prefix + +:Optional Parameters: + + :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) + :build-node: The node to run build on. + :build-timeout: Timeout in minutes before aborting build. (default: 15) + :gerrit-skip-vote: Skip voting for this job. (default: false) + :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) + + :gerrit_verify_triggers: Override Gerrit Triggers. + :gerrit_trigger_file_paths: Override file paths filter which checks which + file modifications will trigger a build. + **default**:: + + - compare-type: REG_EXP + pattern: '(releases\/packagecloud.*\.yaml|\.releases\/packagecloud.*\.yaml)' + + +PackageCloud Release Merge +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This template supports PackageCloud release jobs. + +:template name: {project-name}-packagecloud-release-merge + +:comment trigger: remerge + +:required parameters: + + :build-node: the node to run build on. + :jenkins-ssh-release-credential: credential to use for ssh. (generally set + in defaults.yaml) + :project: git repository name + :project-name: jenkins job name prefix + +:optional parameters: + + :build-days-to-keep: days to keep build logs in jenkins. (default: 7) + :build-timeout: timeout in minutes before aborting build. (default: 15) + + :gerrit_merge_triggers: override gerrit triggers. + :gerrit_trigger_file_paths: override file paths filter which checks which + file modifications will trigger a build. + **default**:: + + - compare-type: reg_exp + pattern: '(releases\/packagecloud.*\.yaml|\.releases\/packagecloud.*\.yaml)' + Setup for LFID, Nexus, Jenkins and Gerrit -----------------------------------------