diff --git a/.github/workflows/e2e-upgrade.yml b/.github/workflows/e2e-upgrade.yml index 986bd87264f..1c3bee39098 100644 --- a/.github/workflows/e2e-upgrade.yml +++ b/.github/workflows/e2e-upgrade.yml @@ -40,7 +40,7 @@ on: type: string required: false toMicroservices: - description: Microservice version to target for the upgrade, empty for upgrade target's default version. + description: Microservice version to target for the upgrade, empty for upgrade target's default version. If simulating a patch upgrade, you must set this value because the default will not be the simulated version. type: string required: false simulatedTargetVersion: diff --git a/dev-docs/workflows/e2e-github-config.md b/dev-docs/workflows/e2e-upgrade-config.md similarity index 73% rename from dev-docs/workflows/e2e-github-config.md rename to dev-docs/workflows/e2e-upgrade-config.md index 56d9bada520..4286e58f118 100644 --- a/dev-docs/workflows/e2e-github-config.md +++ b/dev-docs/workflows/e2e-upgrade-config.md @@ -1,6 +1,9 @@ -## [E2E upgrade test]((https://github.com/edgelesssys/constellation/actions/workflows/e2e-upgrade.yml) +## [E2E upgrade test](() + Make sure to set the correct parameters to avoid late failures: + - it's easiest to use the latest CLI version, because then you can omit all other fields. This works because the devbuild is tagged with the next release version and hence is compatible. - if using an older CLI version: - the last field about simulating a patch-upgrade must have a minor version that is smaller by one compared to the next release - the image version must match the patch field version + - the service version must match the patch field version diff --git a/e2e/provider-upgrade/upgrade_test.go b/e2e/provider-upgrade/upgrade_test.go index 78bcd65b781..3266a6c18f0 100644 --- a/e2e/provider-upgrade/upgrade_test.go +++ b/e2e/provider-upgrade/upgrade_test.go @@ -25,7 +25,7 @@ import ( var ( targetImage = flag.String("target-image", "", "Image (shortversion) to upgrade to.") targetKubernetes = flag.String("target-kubernetes", "", "Kubernetes version (MAJOR.MINOR.PATCH) to upgrade to. Defaults to default version of target CLI.") - targetMicroservices = flag.String("target-microservices", "", "Microservice version (MAJOR.MINOR.PATCH) to upgrade to. Defaults to default version of target CLI.") + targetMicroservices = flag.String("target-microservices", "", "Microservice version (MAJOR.MINOR.PATCH) to upgrade to. Defaults to the pre version of the next release. You must set this value when simulating a patch upgrade.") // When executing the test as a bazel target the CLI path is supplied through an env variable that bazel sets. // When executing via `go test` extra care should be taken that the supplied CLI is built on the same commit as this test. // When executing the test as a bazel target the workspace path is supplied through an env variable that bazel sets.