@bjb-forge/nx-helm-project

Installation

pnpm exec forge add @bjb-forge/nx-helm-project

Plugin Options

{
  "plugin": "@bjb-forge/nx-helm-project/nx-plugin",
  "options": {}
}

Option	Type	Description
`release.targetName`	`string`	The name of the release target
`release.registryUrl`	`string`	The Helm registry URL
`release.registryUsername`	`string`	The Helm registry username
`release.registryPassword`	`string`	The Helm registry password

Helm charts read additional configuration from forge/-prefixed annotations in Chart.yaml. These keys are flat (not nested under a forge map) because Helm requires Chart.yaml's annotations to be a map<string, string>.

apiVersion: v2
name: my-chart
version: 0.1.0

annotations:
  forge/release: 'false'
  forge/registryNamespace: juliusbaer/my-claim/charts

Annotations

Annotation	Description
`forge/release`	Set to `'false'` to disable publishing this chart via `nx release`. Defaults to enabled.
`forge/registryNamespace`	The namespace under the Codeak Helm registry this chart is pushed to, in the form `juliusbaer/<your-claim>/charts`.

Inferred Targets

`nx-release-publish`

Packages and publishes the Helm chart to a registry.

Condition: All projects containing a Chart.yaml

Generators

`chart-project`

Create a Chart.yaml

nx g @bjb-forge/nx-helm-project:chart-project [options]

Option	Type	Required	Default	Description
`directory`	`string`	Yes	-	A directory where the chart is placed.
`name`	`string`	Yes	-	Chart Name

Helm