X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-ci-jobs.rst;h=93ef06748935fa8a407531c1a883c19fc21bcdd5;hb=41c32874d920b94e23fc36c1432a5950ee34cd82;hp=f6895f14c4ae1bea6808374d4b9a93bbd5b97dd0;hpb=cb633b472a2e7a814b24071299d2cde41247f1df;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-ci-jobs.rst b/docs/jjb/lf-ci-jobs.rst index f6895f14..93ef0674 100644 --- a/docs/jjb/lf-ci-jobs.rst +++ b/docs/jjb/lf-ci-jobs.rst @@ -29,6 +29,24 @@ Recommended jobs that should be deployed CI using GitHub. - github-jjb-merge - github-jjb-verify +{project-name}-info-yaml-jobs +----------------------------- + +Jobs to verify INFO.yaml file changes. + +:Includes: + + - gerrit-info-yaml-verify + +{project-name}-github-info-yaml-jobs +------------------------------------ + +Jobs to verify INFO.yaml file changes using Github. + +:Includes: + + - github-info-yaml-verify + {project-name}-packer-jobs -------------------------- @@ -52,6 +70,30 @@ Jobs related to Packer builds for CI using GitHub. Macros ====== +lf-infra-jjb-parameters +----------------------- + +:Required Parameters: + + :jjb-version: Version of Jenkins Job Builder (JJB) to install and use in + the jjb jobs. + +lf-jenkins-cfg-clouds +--------------------- + +Deploys Jenkins Cloud configuration read from the ``jenkins-clouds`` directory +in ci-management repositories. + +.. note:: + + Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style + config definitions for "production" and "sandbox" systems. + +:Required Parameters: + + :jenkins-silos: Space-separated list of Jenkins silos to update + configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini + lf-jenkins-cfg-global-vars -------------------------- @@ -66,7 +108,7 @@ ci-management/jenkins-config/global-vars-SILO.sh script. :Required parameters: - :jenkins-silos: Space separated list of Jenkins silos to update + :jenkins-silos: Space-separated list of Jenkins silos to update configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini lf-infra-jjbini @@ -160,6 +202,8 @@ Full Example: .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-full.yaml :language: yaml +.. _jenkins-cfg-envvar: + Global Environment Variables ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -190,6 +234,9 @@ OpenStack Cloud plugin version supported: * 2.30 * 2.31 * 2.32 +* 2.33 +* 2.34 +* 2.35 Cloud configuration are managed via a directory structure in ci-management as follows: @@ -372,6 +419,65 @@ Runs `jenkins-jobs test` to validate JJB syntax filter which file modifications will trigger a build. (default defined by lf_jjb_common) +.. _info-yaml-verify: + +Info YAML Verify +---------------- + +Info YAML Verify job validates that INFO.yaml file changes are kept isolated from +other file changes. Verifies INFO.yaml files follow the schema defined in +`global-jjb/info-schema`. + +:Template Names: + - {project-name}-info-yaml-verify + - gerrit-info-yaml-verify + - github-info-yaml-verify + +:Required parameters: + + :build-node: The node to run build on. + :jenkins-ssh-credential: Credential to use for SSH. (Generally should + be configured in defaults.yaml) + +:Optional parameters: + + :branch: Git branch to fetch for the build. (default: master) + :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) + :build-timeout: Timeout in seconds before aborting build. (default: 10) + :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) + :stream: Keyword that can be used to represent a release code-name. + Often the same as the branch. (default: master) + :submodule-recursive: Whether to checkout submodules recursively. + (default: true) + :gerrit_verify_triggers: Override Gerrit Triggers. + +.. _license-checker: + +License Checker +--------------- + +Job to scan projects for files missing license headers. + +:Template Names: + - {project-name}-license-check + - gerrit-license-check + - github-license-check + +:Optional parameters: + + :file-patterns: Space-separated list of file patterns to scan. + (default: \*.go \*.groovy \*.java \*.py \*.sh) + :spdx-disable: Disable the SPDX-Identifier checker. (default: false) + :lhc-version: Version of LHC to use. (default: 0.2.0) + :license-exclude-paths: Comma-separated list of paths to exclude from the + license checker. The paths used here will be matched using a contains + rule so it is best to be as precise with the path as possible. + For example a path of '/src/generated/' will be searched as + '**/src/generated/**'. + Example: org/opendaylight/yang/gen,protobuff/messages + (default: '') + :licenses-allowed: Comma-separated list of allowed licenses. + (default: Apache-2.0,EPL-1.0,MIT) .. _gjjb-packer-merge: @@ -399,6 +505,7 @@ Packer Merge job runs `packer build` to build system images in the cloud. :Optional parameters: + :cron: Time when the packer image should be rebuilt (default: @monthly) :branch: Git branch to fetch for the build. (default: master) :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) :build-timeout: Timeout in seconds before aborting build. (default: 10)