Skip to content

Commit

Permalink
Show in docs the ChartSpec.Timeout
Browse files Browse the repository at this point in the history
  • Loading branch information
fmontorsi-equinix authored Nov 18, 2024
1 parent 6c457b8 commit 5e61ccb
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ func ExampleHelmClient_InstallOrUpgradeChart() {
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
Timeout: 32 * time.Second,

Check failure on line 118 in client_test.go

View workflow job for this annotation

GitHub Actions / Verify code generation

undefined: time

Check failure on line 118 in client_test.go

View workflow job for this annotation

GitHub Actions / Run tests (1.23)

undefined: time
}

// Install a chart release.
Expand All @@ -132,6 +133,7 @@ func ExampleHelmClient_InstallOrUpgradeChart_useChartDirectory() {
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
Timeout: 32 * time.Second,

Check failure on line 136 in client_test.go

View workflow job for this annotation

GitHub Actions / Verify code generation

undefined: time

Check failure on line 136 in client_test.go

View workflow job for this annotation

GitHub Actions / Run tests (1.23)

undefined: time
}

if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
Expand All @@ -147,6 +149,7 @@ func ExampleHelmClient_InstallOrUpgradeChart_useLocalChartArchive() {
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
Timeout: 32 * time.Second,

Check failure on line 152 in client_test.go

View workflow job for this annotation

GitHub Actions / Verify code generation

undefined: time

Check failure on line 152 in client_test.go

View workflow job for this annotation

GitHub Actions / Run tests (1.23)

undefined: time
}

if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
Expand All @@ -162,6 +165,7 @@ func ExampleHelmClient_InstallOrUpgradeChart_useURL() {
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
Timeout: 32 * time.Second,

Check failure on line 168 in client_test.go

View workflow job for this annotation

GitHub Actions / Verify code generation

undefined: time

Check failure on line 168 in client_test.go

View workflow job for this annotation

GitHub Actions / Run tests (1.23)

undefined: time
}

if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
Expand All @@ -177,6 +181,7 @@ func ExampleHelmClient_InstallOrUpgradeChart_useDefaultRollBackStrategy() {
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
Timeout: 32 * time.Second,

Check failure on line 184 in client_test.go

View workflow job for this annotation

GitHub Actions / Verify code generation

undefined: time

Check failure on line 184 in client_test.go

View workflow job for this annotation

GitHub Actions / Run tests (1.23)

undefined: time
}

// Use the default rollback strategy offer by HelmClient (revert to the previous version).
Expand Down Expand Up @@ -213,6 +218,7 @@ func ExampleHelmClient_InstallOrUpgradeChart_useCustomRollBackStrategy() {
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
Timeout: 32 * time.Second,

Check failure on line 221 in client_test.go

View workflow job for this annotation

GitHub Actions / Verify code generation

undefined: time

Check failure on line 221 in client_test.go

View workflow job for this annotation

GitHub Actions / Run tests (1.23)

undefined: time
}

// Use a custom rollback strategy (customRollBack needs to implement RollBack).
Expand All @@ -237,6 +243,7 @@ func ExampleHelmClient_LintChart() {
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
Timeout: 32 * time.Second,

Check failure on line 246 in client_test.go

View workflow job for this annotation

GitHub Actions / Verify code generation

undefined: time

Check failure on line 246 in client_test.go

View workflow job for this annotation

GitHub Actions / Run tests (1.23)

undefined: time
ValuesYaml: `deployments:
etcdOperator: true
backupOperator: false`,
Expand All @@ -254,6 +261,7 @@ func ExampleHelmClient_TemplateChart() {
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
Timeout: 32 * time.Second,

Check failure on line 264 in client_test.go

View workflow job for this annotation

GitHub Actions / Verify code generation

undefined: time

Check failure on line 264 in client_test.go

View workflow job for this annotation

GitHub Actions / Run tests (1.23)

undefined: time
ValuesYaml: `deployments:
etcdOperator: true
backupOperator: false`,
Expand Down Expand Up @@ -290,6 +298,7 @@ func ExampleHelmClient_UninstallRelease() {
ChartName: "stable/etcd-operator",
Namespace: "default",
Wait: true,
Timeout: 32 * time.Second,

Check failure on line 301 in client_test.go

View workflow job for this annotation

GitHub Actions / Verify code generation

undefined: time

Check failure on line 301 in client_test.go

View workflow job for this annotation

GitHub Actions / Run tests (1.23)

undefined: time
DryRun: true,
KeepHistory: true,
}
Expand Down Expand Up @@ -337,6 +346,7 @@ func ExampleHelmClient_RollbackRelease() {
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
Timeout: 32 * time.Second,

Check failure on line 349 in client_test.go

View workflow job for this annotation

GitHub Actions / Verify code generation

undefined: time

Check failure on line 349 in client_test.go

View workflow job for this annotation

GitHub Actions / Run tests (1.23)

undefined: time
}

// Rollback to the previous version of the release.
Expand Down

0 comments on commit 5e61ccb

Please sign in to comment.