X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-release-jobs.rst;h=8a1142e1f5cbf07c41ee44c3c48a502d0d37668c;hb=2c01d1c4b9b284118e2854494366e76d41e447f8;hp=5966cd69d403c8f62e9f7f66d9247b28de7bbe4f;hpb=ba4d6e09d765acef795daff7c6db701e73652382;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-release-jobs.rst b/docs/jjb/lf-release-jobs.rst index 5966cd69..8a1142e1 100644 --- a/docs/jjb/lf-release-jobs.rst +++ b/docs/jjb/lf-release-jobs.rst @@ -9,16 +9,15 @@ staging area to a release area. A release yaml file controls the process, and Jenkins promotes the artifact when a project committer merges the release yaml file in Gerrit. -To use the self-release process, create a releases/ or .releases/ -directory at the root of the project repository, add one release yaml -file to it, and submit a change set with that release yaml file. The -required contents of the release yaml file are different for each type -of release, see the schemas and examples shown below. The version -string in the release yaml file should be a valid Semantic Versioning -(SemVer) string, matching the pattern "#.#.#" where "#" is one or more -digits. A version string matching the pattern "v#.#.#" is also -accepted. Upon merge of the change, a Jenkins job promotes the -artifact and pushes a gpg-signed tag to the repository. +To use the self-release process, create a releases/ or .releases/ directory at +the root of the project repository, add one release yaml file to it, and submit +a change set with that release yaml file. The required contents of the release +yaml file are different for each release, see the schemas and examples shown +below. The version string in the release yaml file should be a valid Semantic +Versioning (SemVer) string, matching the pattern "#.#.#" where "#" is one or +more digits. A version string matching the pattern "v#.#.#" is also accepted. +Upon merge of the change, a Jenkins job promotes the artifact and pushes a +gpg-signed tag to the repository. .. note:: @@ -50,6 +49,12 @@ For example, the parameters for a Maven release are as follows:: USE_RELEASE_FILE = false DRY_RUN = false +It's recommended to use Semantic Versions (SemVer) for releases. Refer to +https://semver.org for more details on SemVer. For projects that do not +follow SemVer can use a build parameter (OVERRIDE_SEMVER_REGEX) with the +release job. This build param overrides the default SemVer regex. + + Maven Release Files ------------------- @@ -70,8 +75,8 @@ The following parameters must appear in a maven release yaml file. :Required Parameters: :distribution_type: Must be "maven". - :log_dir: The suffix of the logs URL reported on completion by the - Jenkins stage job that created and pushed the artifact + :log_dir: The suffix of the logs URL reported on successful completion + by the Jenkins stage job that created and pushed the artifact to the staging repository. For example, use value "example-project-maven-stage-master/17" for the logs URL https://logs.lf-project.org/production/vex-sjc-lfp-jenkins-prod-1/example-project-maven-stage-master/17 @@ -82,6 +87,8 @@ The following parameters must appear in a maven release yaml file. :git_tag: The tag string to sign and push to the Git repository. (default: the semantic version string) + :tag_release: Tag Gerrit Repo during the release process. + (default: true) The JSON schema for a maven release file appears below. @@ -132,6 +139,8 @@ The following parameters must appear in a container release yaml file. :git_tag: The tag string to sign and push to the Git repository. (default: the semantic version string) + :tag_release: Tag Gerrit Repo during the release process. + (default: true) The JSON schema for a container release file appears below. @@ -162,9 +171,9 @@ packages. :Required Parameters: - :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 successful completion + by the Jenkins merge job that created and pushed the distribution + files to the staging repository. For example, use value "example-project-pypi-merge-master/17" for the logs URL https://logs.lf-project.org/production/vex-sjc-lfp-jenkins-prod-1/example-project-pypi-merge-master/17 :pypi_project: The PyPI project name at the staging and @@ -179,6 +188,8 @@ packages. :git_tag: The tag string to sign and push to the Git repository. (default: the semantic version string) + :tag_release: Tag Gerrit Repo during the release process. + (default: true) The JSON schema for a PyPI release file appears below. @@ -221,9 +232,9 @@ packages. "curl https://packagecloud.io/api/v1/repos/test_user/test_repo/search?q= | yq -r .[].filename" :ref: The git commit reference (SHA-1 code) to tag with the version string. - :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 successful completion + by the Jenkins merge job that created and pushed the distribution + files to the staging repository. For example, use value "example-project-packagecloud-merge-/21" for the logs URL https://logs.lf-project.org/production/vex-sjc-lfp-jenkins-prod-1/example-project-packagecloud-merge/21 :version: The semantic version string used for the package. @@ -232,6 +243,8 @@ packages. :git_tag: The tag string to sign and push to the Git repository. (default: the semantic version string) + :tag_release: Tag Gerrit Repo during the release process. + (default: true) The JSON schema for a PackageCloud release file appears below. @@ -239,6 +252,15 @@ The JSON schema for a PackageCloud release file appears below. :language: yaml +Job Groups +========== + +Below is a list of Release job groups: + +.. literalinclude:: ../../jjb/lf-release-job-groups.yaml + :language: yaml + + Jenkins Jobs ------------ @@ -279,7 +301,11 @@ Release Merge This template supports Maven and Container release jobs. -:Template Name: {project-name}-release-merge +This template uses a git commit choosing strategy that builds the merged +commit with the release yaml file, not the tip of the target branch, so +projects can repeat the release action in case of merge job failure. + +:Template Name: {project-name}-release-merge-{stream} :Comment Trigger: remerge @@ -295,14 +321,13 @@ This template supports Maven and Container release jobs. :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) :build-timeout: Timeout in minutes before aborting build. (default: 15) + :stream: Keyword that represents a release code-name. + Often the same as the branch. (default: master) :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\/.*\.yaml|\.releases\/.*\.yaml)' + file modifications will trigger a build. The default pattern is the + regular expression ``(releases\/.*\.yaml|\.releases\/.*\.yaml)`` Release Verify @@ -310,7 +335,7 @@ Release Verify This template supports Maven and Container release jobs. -:Template Name: {project-name}-release-verify +:Template Name: {project-name}-release-verify-{stream} :Comment Trigger: recheck|reverify @@ -329,14 +354,13 @@ This template supports Maven and Container release jobs. :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) + :stream: Keyword that represents a release code-name. + Often the same as the branch. (default: master) :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\/.*\.yaml|\.releases\/.*\.yaml)' + file modifications will trigger a build. The default pattern is the + regular expression ``(releases\/.*\.yaml|\.releases\/.*\.yaml)`` PyPI Release Merge @@ -349,6 +373,10 @@ artifacts to the PyPI release repository, tags the git repository, signs the tag and pushes the tag to the git server. The release merge template accepts neither a branch nor a stream parameter. +These templates use a git commit choosing strategy that builds the merged +commit with the release yaml file, not the tip of the target branch, so +projects can repeat the release action in case of merge job failure. + :Template Names: - {project-name}-pypi-release-merge @@ -377,12 +405,9 @@ 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)' + :gerrit_release_trigger_file_paths: Override file paths filter which checks + which file modifications will trigger a build. The default pattern is the + regular expression ``(releases\/pypi.*\.yaml|\.releases\/pypi.*\.yaml)`` PyPI Release Verify ~~~~~~~~~~~~~~~~~~~ @@ -421,17 +446,17 @@ 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)' + :gerrit_release_trigger_file_paths: Override file paths filter which checks + which file modifications will trigger a build. The default pattern is the + regular expression ``(releases\/pypi.*\.yaml|\.releases\/pypi.*\.yaml)`` PackageCloud Release Verify ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This template supports PackageCloud release jobs. +This template supports PackageCloud release jobs. Checks that the specified +packages are present in the staging repository and absent from the release +repository. The file path trigger uses the regular expression +``(releases\/packagecloud.*\.yaml|\.releases\/packagecloud.*\.yaml)`` :Template Name: {project-name}-packagecloud-release-verify @@ -453,25 +478,23 @@ This template supports PackageCloud release jobs. :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. +This template supports PackageCloud release jobs. Promotes the specified +packages from the staging repository to the release repository. +The file path trigger uses the regular expression +``(releases\/packagecloud.*\.yaml|\.releases\/packagecloud.*\.yaml)`` -:template name: {project-name}-packagecloud-release-merge +This template uses a git commit choosing strategy that builds the merged +commit with the release yaml file, not the tip of the target branch, so +projects can repeat the release action in case of merge job failure. -:comment trigger: remerge +:Template Name: {project-name}-packagecloud-release-merge -:required parameters: +:Comment Trigger: remerge + +:Required Parameters: :build-node: the node to run build on. :jenkins-ssh-release-credential: credential to use for ssh. (generally set @@ -479,20 +502,11 @@ This template supports PackageCloud release jobs. :project: git repository name :project-name: jenkins job name prefix -:optional parameters: +: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 -----------------------------------------