helm-ci
This Dagger scenario composes the local Helm and Git modules into portableHelm chart verification and publication workflows.
Installation
dagger install github.com/riftonix/daggerverse/scenarios/helm-ci@v1.4.0Entrypoint
Return Type
HelmCi !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| source | Directory | - | Repository root directory |
| helmImageRegistry | String | "docker.io" | Helm image registry |
| helmImageRepository | String | "alpine/helm" | Helm image repository |
| helmImageTag | String | "4.3.2" | Helm image tag |
| helmContainerUserId | String | "65532" | Helm container user |
| gitImageRegistry | String | "docker.io" | Git image registry for changed-chart detection |
| gitImageRepository | String | "alpine/git" | Git image repository for changed-chart detection |
| gitImageTag | String | "v2.54.1" | Git image tag for changed-chart detection |
| gitContainerUserId | String | "65532" | Git container user for changed-chart detection |
| helmUnittestImageRegistry | String | "docker.io" | Helm unittest image registry |
| helmUnittestImageRepository | String | "helmunittest/helm-unittest" | Helm unittest image repository |
| helmUnittestImageTag | String | "4.2.0-1.1.0" | Helm unittest image tag |
| helmUnittestContainerUserId | String | "65532" | Helm unittest container user |
| updatecliImageRegistry | String | "ghcr.io" | Updatecli image registry for chart sync |
| updatecliImageRepository | String | "riftonix/container-images/updatecli-python-nodejs" | Updatecli image repository for chart sync; needs Python, PyYAML, Git, and Helm |
| updatecliImageTag | String | "py3.14-node26-updatecli0.123.0-pyyaml6.0.3-helm4.3.2" | Updatecli image tag for chart sync |
| updatecliContainerUserId | String | "65532" | Updatecli container user for chart sync |
Example
dagger -m github.com/riftonix/daggerverse/scenarios/helm-ci@7be23092b4bc23f37a002ce0125d3bf7fa601346 call \
func (m *MyModule) Example() *dagger.HelmCi {
return dag.
Helmci()
}@function
def example() -> dagger.HelmCi:
return (
dag.helm_ci()
)@func()
example(): HelmCi {
return dag
.helmCi()
}Types
HelmCi 🔗
getChartReleaseTag() 🔗
Return the chart-scoped Git release tag.
Return Type
String !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| gitTagPrefix | String ! | - | Git release tag prefix for the chart |
| chartSource | Directory | null | Optional Helm chart directory; defaults to the scenario source |
| version | String | null | Optional chart version override |
Example
dagger -m github.com/riftonix/daggerverse/scenarios/helm-ci@7be23092b4bc23f37a002ce0125d3bf7fa601346 call \
get-chart-release-tag --git-tag-prefix stringfunc (m *MyModule) Example(ctx context.Context, gitTagPrefix string) string {
return dag.
Helmci().
Getchartreleasetag(ctx, gitTagPrefix)
}@function
async def example(gittagprefix: str) -> str:
return await (
dag.helm_ci()
.getchartreleasetag(gittagprefix)
)@func()
async example(gitTagPrefix: string): Promise<string> {
return dag
.helmCi()
.getChartReleaseTag(gitTagPrefix)
}getOciRegistryHost() 🔗
Return the registry host from an OCI destination URL.
Return Type
String !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| ociUrl | String ! | - | OCI destination URL without the chart name |
Example
dagger -m github.com/riftonix/daggerverse/scenarios/helm-ci@7be23092b4bc23f37a002ce0125d3bf7fa601346 call \
get-oci-registry-host --oci-url stringfunc (m *MyModule) Example(ctx context.Context, ociUrl string) string {
return dag.
Helmci().
Getociregistryhost(ctx, ociUrl)
}@function
async def example(ociurl: str) -> str:
return await (
dag.helm_ci()
.getociregistryhost(ociurl)
)@func()
async example(ociUrl: string): Promise<string> {
return dag
.helmCi()
.getOciRegistryHost(ociUrl)
}publishChart() 🔗
Publish one Helm chart and push its Git release tag.
Return Type
String !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| ociUrl | String ! | - | OCI destination URL without the chart name |
| gitTagPrefix | String ! | - | Git release tag prefix for the chart |
| gitToken | Secret | null | Optional HTTPS token used to push the release Git tag |
| chartSource | Directory | null | Optional Helm chart directory; defaults to the scenario source |
| version | String | null | Optional chart version override |
| appVersion | String | null | Optional appVersion override |
| withDependencyUpdate | Boolean ! | true | Run Helm dependency update before publishing |
| registryLogin | String | null | Registry login used to publish the chart |
| registryPassword | Secret | null | Registry password used to publish the chart |
| registryAddress | String | null | Optional registry login address; defaults to the host from the OCI URL |
| insecure | Boolean | false | Allow plain http pushes |
| gitHost | String ! | "github.com" | HTTPS Git host used for release tag authentication |
| gitUsername | String ! | "x-access-token" | HTTPS Git username used for release tag authentication |
| gitRemote | String ! | "origin" | Git remote that receives the release tag |
Example
dagger -m github.com/riftonix/daggerverse/scenarios/helm-ci@7be23092b4bc23f37a002ce0125d3bf7fa601346 call \
publish-chart --oci-url string --git-tag-prefix string --with-dependency-update boolean --git-host string --git-username string --git-remote stringfunc (m *MyModule) Example(ctx context.Context, ociUrl string, gitTagPrefix string, withDependencyUpdate bool, gitHost string, gitUsername string, gitRemote string) string {
return dag.
Helmci().
Publishchart(ctx, ociUrl, gitTagPrefix, withDependencyUpdate, gitHost, gitUsername, gitRemote)
}@function
async def example(ociurl: str, gittagprefix: str, withdependencyupdate: bool, githost: str, gitusername: str, gitremote: str) -> str:
return await (
dag.helm_ci()
.publishchart(ociurl, gittagprefix, withdependencyupdate, githost, gitusername, gitremote)
)@func()
async example(ociUrl: string, gitTagPrefix: string, withDependencyUpdate: boolean, gitHost: string, gitUsername: string, gitRemote: string): Promise<string> {
return dag
.helmCi()
.publishChart(ociUrl, gitTagPrefix, withDependencyUpdate, gitHost, gitUsername, gitRemote)
}syncCharts() 🔗
Synchronize components from upstream and return the updated source.
Return Type
Directory !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| configPath | String ! | "updatecli/values.yaml" | Chart sync configuration in source; pins are read from pins/ next to it |
| components | [String ! ] | null | Component IDs; all components when empty |
Example
dagger -m github.com/riftonix/daggerverse/scenarios/helm-ci@7be23092b4bc23f37a002ce0125d3bf7fa601346 call \
sync-charts --config-path stringfunc (m *MyModule) Example(configPath string) *dagger.Directory {
return dag.
Helmci().
Synccharts(configPath)
}@function
def example(configpath: str) -> dagger.Directory:
return (
dag.helm_ci()
.synccharts(configpath)
)@func()
example(configPath: string): Directory {
return dag
.helmCi()
.syncCharts(configPath)
}syncChartsDiff() 🔗
Preview upstream chart updates on source without writing files.
Return Type
String !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| configPath | String ! | "updatecli/values.yaml" | Chart sync configuration in source; pins are read from pins/ next to it |
| components | [String ! ] | null | Component IDs; all components when empty |
Example
dagger -m github.com/riftonix/daggerverse/scenarios/helm-ci@7be23092b4bc23f37a002ce0125d3bf7fa601346 call \
sync-charts-diff --config-path stringfunc (m *MyModule) Example(ctx context.Context, configPath string) string {
return dag.
Helmci().
Syncchartsdiff(ctx, configPath)
}@function
async def example(configpath: str) -> str:
return await (
dag.helm_ci()
.syncchartsdiff(configpath)
)@func()
async example(configPath: string): Promise<string> {
return dag
.helmCi()
.syncChartsDiff(configPath)
}syncChartsManifest() 🔗
Render the Updatecli manifest: local pipelines, or GitHub pipelines with repository and branch.
Return Type
String !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| configPath | String ! | "updatecli/values.yaml" | Chart sync configuration in source; pins are read from pins/ next to it |
| components | [String ! ] | null | Component IDs; all components when empty |
| repository | String | null | GitHub repository owner/name for pull request mode |
| branch | String | null | GitHub base branch for pull request mode |
Example
dagger -m github.com/riftonix/daggerverse/scenarios/helm-ci@7be23092b4bc23f37a002ce0125d3bf7fa601346 call \
sync-charts-manifest --config-path stringfunc (m *MyModule) Example(ctx context.Context, configPath string) string {
return dag.
Helmci().
Syncchartsmanifest(ctx, configPath)
}@function
async def example(configpath: str) -> str:
return await (
dag.helm_ci()
.syncchartsmanifest(configpath)
)@func()
async example(configPath: string): Promise<string> {
return dag
.helmCi()
.syncChartsManifest(configPath)
}syncChartsUpdate() 🔗
Propose each upstream chart update as a GitHub pull request on its own working branch.
Return Type
String !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| githubToken | Secret ! | - | GitHub token that pushes branches and opens pull requests |
| repository | String ! | - | GitHub repository owner/name |
| branch | String ! | - | GitHub base branch |
| configPath | String ! | "updatecli/values.yaml" | Chart sync configuration in source; pins are read from pins/ next to it |
| components | [String ! ] | null | Component IDs; all components when empty |
Example
dagger -m github.com/riftonix/daggerverse/scenarios/helm-ci@7be23092b4bc23f37a002ce0125d3bf7fa601346 call \
sync-charts-update --github-token env:MYSECRET --repository string --branch string --config-path stringfunc (m *MyModule) Example(ctx context.Context, githubToken *dagger.Secret, repository string, branch string, configPath string) string {
return dag.
Helmci().
Syncchartsupdate(ctx, githubToken, repository, branch, configPath)
}@function
async def example(githubtoken: dagger.Secret, repository: str, branch: str, configpath: str) -> str:
return await (
dag.helm_ci()
.syncchartsupdate(githubtoken, repository, branch, configpath)
)@func()
async example(githubToken: Secret, repository: string, branch: string, configPath: string): Promise<string> {
return dag
.helmCi()
.syncChartsUpdate(githubToken, repository, branch, configPath)
}updatecliContainer() 🔗
Return the Updatecli runtime container used by the chart sync functions.
Return Type
Container ! Example
dagger -m github.com/riftonix/daggerverse/scenarios/helm-ci@7be23092b4bc23f37a002ce0125d3bf7fa601346 call \
updatecli-containerfunc (m *MyModule) Example() *dagger.Container {
return dag.
Helmci().
Updateclicontainer()
}@function
def example() -> dagger.Container:
return (
dag.helm_ci()
.updateclicontainer()
)@func()
example(): Container {
return dag
.helmCi()
.updatecliContainer()
}verifyChart() 🔗
Verify the Helm chart supplied as the scenario source.
Return Type
String !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| values | File | null | Optional values.yaml file |
| releaseName | String ! | "ci-release" | Helm release name for templating |
| chartSource | Directory | null | Optional Helm chart directory; defaults to the scenario source |
| unittestSuiteFiles | [String ! ] | null | Optional Helm unittest suite file glob patterns |
Example
dagger -m github.com/riftonix/daggerverse/scenarios/helm-ci@7be23092b4bc23f37a002ce0125d3bf7fa601346 call \
verify-chart --release-name stringfunc (m *MyModule) Example(ctx context.Context, releaseName string) string {
return dag.
Helmci().
Verifychart(ctxreleaseName)
}@function
async def example(releasename: str) -> str:
return await (
dag.helm_ci()
.verifychart(releasename)
)@func()
async example(releaseName: string): Promise<string> {
return dag
.helmCi()
.verifyChart(releaseName)
}withUpdatecliContainer() 🔗
Run the chart sync functions in a caller-provided runtime derived from updatecli_container().
Return Type
HelmCi !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| container | Container ! | - | Custom Updatecli runtime, for example with bound services |
Example
dagger -m github.com/riftonix/daggerverse/scenarios/helm-ci@7be23092b4bc23f37a002ce0125d3bf7fa601346 call \
with-updatecli-container --container IMAGE:TAGfunc (m *MyModule) Example(container *dagger.Container) *dagger.HelmCi {
return dag.
Helmci().
Withupdateclicontainer(container)
}@function
def example(container: dagger.Container) -> dagger.HelmCi:
return (
dag.helm_ci()
.withupdateclicontainer(container)
)@func()
example(container: Container): HelmCi {
return dag
.helmCi()
.withUpdatecliContainer(container)
}