@magda/ci-utils v1.0.5

ci-utils

A set of CI scripts that helps set up CI.

check-helm-chart-version

Make sure the helm chart version is same as current Github Release Tag Name Version.

Usage:

yarn check-helm-chart-version [path to chart.yaml file of the chart...]

update-helm-chart-version

Update the version of all helm charts in a folder to a new version number.

Usage:

Add the following scripts entries to your package.json:

"add-all-chart-version-changes": "git ls-files -m | grep Chart.yaml | xargs git add && git ls-files -m | grep Chart.lock | xargs git add",
"add-all-helm-docs-changes": "helm-docs && git ls-files -m | grep -i readme.md | xargs git add",
"version": "yarn update-helm-chart-version && yarn update-all-charts && yarn add-all-chart-version-changes && yarn add-all-helm-docs-changes"

Then you can run:

npm version [new version number]

to set version.

Config Options

You can set the following fields in package.json to customize the helm chart version update behavior:

• versionUpdateExclude:
  • Type: string[]
  • You can set versionUpdateExclude field of package.json to specify a list charts that should be excluded from changing version.

• versionUpdateValues:

  • Type: { [chartName:string]: string[]; }
  • This field allow you to specify a list fields that should be update to current version in selected charts' "values" files.

  e.g. the following config:

  "versionUpdateValues": {
    "helm-chart-A": [
      "field1.field2.field3",
      "field4"
    ],
    "helm-chart-B": ["field5"]
  }

  will make the following fields:

  • helm-chart-A chart's "field1.field2.field3" & "field4" fields
  • helm-chart-Bchart's "field5" field

  set to the current package version.