Skip to content

Commit

Permalink
clarify simulated patch version upgrade docs
Browse files Browse the repository at this point in the history
  • Loading branch information
elchead committed Oct 22, 2024
1 parent 6d3133d commit b020f53
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/e2e-upgrade.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
## [E2E upgrade test]((https://github.com/edgelesssys/constellation/actions/workflows/e2e-upgrade.yml)
## [E2E upgrade test]((<https://github.com/edgelesssys/constellation/actions/workflows/e2e-upgrade.yml>)

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
2 changes: 1 addition & 1 deletion e2e/provider-upgrade/upgrade_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit b020f53

Please sign in to comment.