Skip to content
Snippets Groups Projects
Commit 20e8c048 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

feat(release): implement 2 steps release

parent 4e010798
Branches
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
README.md
+ 15
− 10
View file @ 20e8c048
...@@ -159,22 +159,27 @@ It is bound to the `test` stage, and uses the following variables: ...@@ -159,22 +159,27 @@ It is bound to the `test` stage, and uses the following variables:
| `MAVEN_SBOM_DISABLED` | Set to `true` to disable this job | _none_ | | `MAVEN_SBOM_DISABLED` | Set to `true` to disable this job | _none_ |
| `MAVEN_SBOM_GEN_ARGS` | Maven command used for SBOM analysis | `org.cyclonedx:cyclonedx-maven-plugin:makeAggregateBom` | | `MAVEN_SBOM_GEN_ARGS` | Maven command used for SBOM analysis | `org.cyclonedx:cyclonedx-maven-plugin:makeAggregateBom` |
### `mvn-snapshot` & `mvn-release` jobs ### `mvn-release` & `mvn-deploy-*` jobs
These jobs are **disabled by default** and perform, respectively, the following: These jobs are **disabled by default** and - when enabled - respectively perform the following:
* a [Maven deploy](https://maven.apache.org/plugins/maven-deploy-plugin/) of your Java packages (jar, war, etc.), 1. a [Maven release:prepare](https://maven.apache.org/maven-release/maven-release-plugin/usage/prepare-release.html) of your current branch
* a [Maven release](http://maven.apache.org/maven-release/maven-release-plugin/index.html) of your current branch. * only triggers the first part of the release (version changes in `pom.xml`, Git commits and version tag)
* provides a default integration with `semantic-release` ([see below](#semantic-release-integration))
* the second part of the release (package and publish to a Maven registry) is performed by the `mvn-deploy` job below
2. a [Maven deploy](https://maven.apache.org/plugins/maven-deploy-plugin/) of your Java packages (jar, war, etc.) to any Maven-compliant registry
* `mvn-deploy-release` publishes the **stable** version on the tag pipeline triggered by a `mvn-release`,
* `mvn-deploy-snapshot` publishes the **snapshot** version on other branches.
They are bound to the `publish` stage, and use the following variables: They are bound to the `publish` stage, and use the following variables:
| Name | description | default value | | Name | description | default value |
| ----------------------------------- | ------------------------------------------------------------ | ----------------- | | ----------------------------------- | ------------------------------------------------------------ | ----------------- |
| `MAVEN_DEPLOY_ENABLED` | Set to `true` to enable a publish jobs | _none_ (disabled) | | `MAVEN_DEPLOY_ENABLED` | Set to `true` to enable release and publish jobs | _none_ (disabled) |
| `MAVEN_DEPLOY_FROM_UNPROTECTED_DISABLED`| Set to `true` to limit snapshot publication to protected branches | _none_ (disabled) | | `MAVEN_DEPLOY_FROM_UNPROTECTED_DISABLED`| Set to `true` to limit snapshot publication to protected branches | _none_ (disabled) |
| `MAVEN_DEPLOY_ARGS` | Maven arguments for the Snapshot job | `deploy -Dmaven.test.skip=true` | | `MAVEN_DEPLOY_ARGS` | Maven arguments for the `mvn-deploy` job | `deploy -Dmaven.test.skip=true` |
| `MAVEN_RELEASE_ARGS` | Maven arguments for the Release job | `release:prepare release:perform -Darguments=-Dmaven.test.skip=true` | | `MAVEN_RELEASE_ARGS` | Maven arguments for the `mvn-release` job | `release:prepare -DtagNameFormat=@{project.version} -Darguments=-Dmaven.test.skip=true` |
| `MAVEN_RELEASE_SCM_COMMENT_PREFIX` | Maven release plugin [scmCommentPrefix](https://maven.apache.org/maven-release/maven-release-plugin/prepare-mojo.html#scmCommentPrefix) parameter | `[ci skip][maven-release-plugin]` | | `MAVEN_RELEASE_SCM_COMMENT_PREFIX` | Maven release plugin [scmCommentPrefix](https://maven.apache.org/maven-release/maven-release-plugin/prepare-mojo.html#scmCommentPrefix) parameter | `chore(maven-release): ` |
| `MVN_SEMREL_RELEASE_DISABLED` | Set to `true` to disable [semantic-release integration](#semantic-release-integration) | _none_ (disabled) | | `MVN_SEMREL_RELEASE_DISABLED` | Set to `true` to disable [semantic-release integration](#semantic-release-integration) | _none_ (disabled) |
More info: More info:
......
kicker.json
+ 6
− 6
View file @ 20e8c048
...@@ -123,13 +123,13 @@ ...@@ -123,13 +123,13 @@
{ {
"id": "publish", "id": "publish",
"name": "Publish", "name": "Publish",
"description": "Publish [Snapshot](https://maven.apache.org/plugins/maven-deploy-plugin/) & [Releases](http://maven.apache.org/maven-release/maven-release-plugin) to a Nexus repository", "description": "Publish [Snapshot](https://maven.apache.org/plugins/maven-deploy-plugin/) & [Releases](http://maven.apache.org/maven-release/maven-release-plugin) to a Maven-compliant repository",
"enable_with": "MAVEN_DEPLOY_ENABLED", "enable_with": "MAVEN_DEPLOY_ENABLED",
"variables": [ "variables": [
{ {
"name": "MAVEN_DEPLOY_ARGS", "name": "MAVEN_DEPLOY_ARGS",
"description": "Maven arguments for the Snapshot job", "description": "Maven arguments for the deploy job",
"default": "deploy -DskipTests", "default": "deploy -Dmaven.test.skip=true",
"advanced": true "advanced": true
}, },
{ {
...@@ -140,14 +140,14 @@ ...@@ -140,14 +140,14 @@
}, },
{ {
"name": "MAVEN_RELEASE_ARGS", "name": "MAVEN_RELEASE_ARGS",
"description": "Maven arguments for the Release job", "description": "Maven arguments for the release job",
"default": "release:prepare release:perform -DskipTests", "default": "release:prepare -DtagNameFormat=@{project.version} -Darguments=-Dmaven.test.skip=true",
"advanced": true "advanced": true
}, },
{ {
"name": "MAVEN_RELEASE_SCM_COMMENT_PREFIX", "name": "MAVEN_RELEASE_SCM_COMMENT_PREFIX",
"description": "Maven release plugin [scmCommentPrefix](https://maven.apache.org/maven-release/maven-release-plugin/prepare-mojo.html#scmCommentPrefix) parameter", "description": "Maven release plugin [scmCommentPrefix](https://maven.apache.org/maven-release/maven-release-plugin/prepare-mojo.html#scmCommentPrefix) parameter",
"default": "[ci skip][maven-release-plugin]", "default": "chore(maven-release): ",
"advanced": true "advanced": true
}, },
{ {
......
templates/gitlab-ci-maven.yml
+ 39
− 25
View file @ 20e8c048
...@@ -54,6 +54,8 @@ variables: ...@@ -54,6 +54,8 @@ variables:
PROD_REF: '/^(master|main)$/' PROD_REF: '/^(master|main)$/'
# default integration ref name (pattern) # default integration ref name (pattern)
INTEG_REF: '/^develop$/' INTEG_REF: '/^develop$/'
# default release tag name (pattern)
RELEASE_REF: '/^v?[0-9]+\.[0-9]+\.[0-9]+$/'
# default configuration directory # default configuration directory
MAVEN_CFG_DIR: ".m2" MAVEN_CFG_DIR: ".m2"
...@@ -105,8 +107,8 @@ variables: ...@@ -105,8 +107,8 @@ variables:
MAVEN_DEPLOY_ARGS: "deploy -Dmaven.test.skip=true" MAVEN_DEPLOY_ARGS: "deploy -Dmaven.test.skip=true"
# Maven release arguments # Maven release arguments
MAVEN_RELEASE_ARGS: "release:prepare release:perform -Darguments=-Dmaven.test.skip=true" MAVEN_RELEASE_ARGS: "release:prepare -DtagNameFormat=@{project.version} -Darguments=-Dmaven.test.skip=true"
MAVEN_RELEASE_SCM_COMMENT_PREFIX: "[ci skip][maven-release-plugin]" MAVEN_RELEASE_SCM_COMMENT_PREFIX: "chore(maven-release): "
stages: stages:
- build - build
...@@ -355,19 +357,20 @@ stages: ...@@ -355,19 +357,20 @@ stages:
fi fi
} }
function perform_snapshot() { function mvn_deploy() {
# shellcheck disable=SC2086 # shellcheck disable=SC2086
pom_version=$(mvn $MAVEN_CLI_OPTS $mvn_settings_opt $java_proxy_args org.apache.maven.plugins:maven-help-plugin:3.2.0:evaluate -Dexpression=project.version -q -DforceStdout | tail -n 1) pom_version=$(mvn $MAVEN_CLI_OPTS $mvn_settings_opt $java_proxy_args org.apache.maven.plugins:maven-help-plugin:3.2.0:evaluate -Dexpression=project.version -q -DforceStdout | tail -n 1)
case $pom_version in if [[ "$CI_COMMIT_TAG" ]] && [[ "$pom_version" =~ -SNAPSHOT$ ]]
*-SNAPSHOT) then
log_info "Snapshot version for pom (\\e[33;1m${pom_version}\\e[0m): deploy" log_warn "Can't publish SNAPSHOT version \\e[33;1m${pom_version}\\e[0m from tag: skip"
elif [[ -z "$CI_COMMIT_TAG" ]] && [[ ! "$pom_version" =~ -SNAPSHOT$ ]]
then
log_warn "Can't publish non-SNAPSHOT version \\e[33;1m${pom_version}\\e[0m from branch: skip"
else
log_info "Publish version \\e[33;1m${pom_version}\\e[0m..."
# shellcheck disable=SC2086 # shellcheck disable=SC2086
mvn ${TRACE+-X} $MAVEN_CLI_OPTS $mvn_settings_opt $java_proxy_args $MAVEN_DEPLOY_ARGS mvn ${TRACE+-X} $MAVEN_CLI_OPTS $mvn_settings_opt $java_proxy_args $MAVEN_DEPLOY_ARGS
;; fi
*)
log_info "Not snapshot version for pom (\\e[33;1m${pom_version}\\e[0m): skip"
;;
esac
} }
unscope_variables unscope_variables
...@@ -510,20 +513,32 @@ mvn-sbom: ...@@ -510,20 +513,32 @@ mvn-sbom:
when: never when: never
- !reference [.test-policy, rules] - !reference [.test-policy, rules]
mvn-snapshot: mvn-deploy-snapshot:
extends: .mvn-base extends: .mvn-base
stage: publish stage: publish
script: script:
- perform_snapshot - mvn_deploy
rules: rules:
# exclude if $MAVEN_DEPLOY_ENABLED not set
- if: '$MAVEN_DEPLOY_ENABLED != "true"'
when: never
# on tags: never # on tags: never
- if: $CI_COMMIT_TAG - if: $CI_COMMIT_TAG
when: never when: never
# exclude unprotected ref if specified # exclude unprotected ref if disabled
- if: '$MAVEN_DEPLOY_FROM_UNPROTECTED_DISABLED == "true" && $CI_COMMIT_REF_PROTECTED != "true"' - if: '$MAVEN_DEPLOY_FROM_UNPROTECTED_DISABLED != "true" || $CI_COMMIT_REF_PROTECTED == "true"'
mvn-deploy-release:
extends: .mvn-base
stage: publish
script:
- mvn_deploy
rules:
# exclude if $MAVEN_DEPLOY_ENABLED not set
- if: '$MAVEN_DEPLOY_ENABLED != "true"'
when: never when: never
# else: if $MAVEN_DEPLOY_ENABLED is set # on tag with release pattern: auto
- if: '$MAVEN_DEPLOY_ENABLED == "true"' - if: '$CI_COMMIT_TAG =~ $RELEASE_REF'
mvn-release: mvn-release:
extends: .mvn-base extends: .mvn-base
...@@ -551,11 +566,10 @@ mvn-release: ...@@ -551,11 +566,10 @@ mvn-release:
fi fi
- mvn ${TRACE+-X} $MAVEN_CLI_OPTS $mvn_settings_opt $java_proxy_args $scm_auth_args ${MAVEN_RELEASE_ARGS} ${semrel_args} -DscmCommentPrefix="$MAVEN_RELEASE_SCM_COMMENT_PREFIX" - mvn ${TRACE+-X} $MAVEN_CLI_OPTS $mvn_settings_opt $java_proxy_args $scm_auth_args ${MAVEN_RELEASE_ARGS} ${semrel_args} -DscmCommentPrefix="$MAVEN_RELEASE_SCM_COMMENT_PREFIX"
rules: rules:
# on production branch(es): manual & non-blocking if $MAVEN_DEPLOY_ENABLED is set # exclude if $MAVEN_DEPLOY_ENABLED not set
- if: '$MAVEN_DEPLOY_ENABLED == "true" && $CI_COMMIT_REF_NAME =~ $PROD_REF' - if: '$MAVEN_DEPLOY_ENABLED != "true"'
when: manual when: never
allow_failure: true # on production or integration branch: manual, non blocking
# on integration branch(es): manual & non-blocking if $MAVEN_DEPLOY_ENABLED is set - if: '$CI_COMMIT_REF_NAME =~ $PROD_REF || $CI_COMMIT_REF_NAME =~ $INTEG_REF'
- if: '$MAVEN_DEPLOY_ENABLED == "true" && $CI_COMMIT_REF_NAME =~ $INTEG_REF'
when: manual when: manual
allow_failure: true allow_failure: true
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment