# semantic-release-helm-app

> semantic-release plugin to update version and appVersion in a Helm chart

Latest version **3.0.6** (published 2022-09-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install semantic-release-helm-app
pnpm add semantic-release-helm-app
yarn add semantic-release-helm-app
bun add semantic-release-helm-app
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.6 |
| Published | 2022-09-22 |
| First published | 2021-09-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 11.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ahmad Abdelaziz |
| Maintainers | 3b3ziz, ahmed.itman |

## Links

- npm: https://www.npmjs.com/package/semantic-release-helm-app
- Repository: https://github.com/swvl/semantic-release-helm
- Homepage: https://github.com/swvl/semantic-release-helm#readme
- Issues: https://github.com/swvl/semantic-release-helm/issues
- npm.io page: https://npm.io/package/semantic-release-helm-app

## Dependencies (7)

- [path](https://npm.io/package/path.md) ^0.12.7
- [execa](https://npm.io/package/execa.md) ^5.0.0
- [semver](https://npm.io/package/semver.md) ^7.3.4
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.1005.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.0
- [minimatch](https://npm.io/package/minimatch.md) ^3.0.4
- [aggregate-error](https://npm.io/package/aggregate-error.md) ^3.1.0

## Recent versions

- 3.0.6 (latest) — 2022-09-22
- 3.0.5 — 2022-08-23
- 3.0.3 — 2022-03-24
- 3.0.2 — 2021-10-25
- 3.0.1 — 2021-10-13
- 3.0.0 — 2021-10-12
- 1.0.4 — 2021-10-11
- 1.0.3 — 2021-10-05
- 1.0.2 — 2021-09-29
- 1.0.1 — 2021-09-29
- 1.0.0 — 2021-09-29

## README

# semantic-release-helm

This is a plugin for _semantic-release_. It updates `version` and `appVersion` of a [Helm](https://helm.sh/) chart's
_Chart.yaml_.

The `version` is increased according to `nextRelease.type`, which can be one of

- major
- premajor
- minor
- preminor
- patch
- prepatch
- prerelease

or _null_ if it's not valid.

The `appVersion` is set to `nextRelease.version` if `onlyUpdateVersion`is false or unset.

## BREAKING CHANGE in v2

`path` has been renamed to `chartPath` to prevent config conflicts.

##### Examples:

```
version 0.1.0  
appVersion 1.16.0
```

1. patch (1.16.0 -> 1.16.1)  
   New chart version is 0.1.1

2. minor (1.16.0 -> 1.17.0)  
   New chart version is 0.2.0

3. major (1.16.0 -> 2.0.0)  
   New chart version is 1.0.0

## Configuration

- chartPath (required) - string
  Chart directory, where the _Chart.yaml_ is located.

- registry (optional) - string  
  URI of a container registry.

- onlyUpdateVersion (optional) - boolean (default: false)  
  Don't change `appVersion` if this is true. Useful if your chart is in a different git repo than the application.

Pass credentials through environment variables accordingly:

```
export REGISTRY_USERNAME=<USERNAME>
export REGISTRY_PASSWORD=<PASSWORD>
```

For S3 pass the AWS credentials as environment variables:

```
export AWS_REGION=<REGION>
export AWS_ACCESS_KEY_ID=<ACCESS_KEY_ID>
export AWS_SECRET_ACCESS_KEY=<SECRET_ACCESS_KEY>
```

## Example

This will update `version` and `appVersion` in `./chart/Chart.yaml`
and push the chart to `localhost:5000/repo/chart`. The image will be tagged with the value of `version` from
_Chart.yaml_.

```
{
  "plugins": [
    [
      "semantic-release-helm",
      {
        chartPath: './chart',
        registry: 'localhost:5000/repo/chart'
      }
    ]
  ]
}
```

## S3 Example

The [helm-s3](https://github.com/hypnoglow/helm-s3) plugin adds support for S3. Check the documentation for additional
options

This will update `version` in `./chart/Chart.yaml`
and push the chart to `s3://my-s3-bucket/s3-prefix`. The image will be tagged with the value of `version` from
_Chart.yaml_.

```
{
  "plugins": [
    [
      "semantic-release-helm",
      {
        chartPath: './chart',
        registry: 's3://my-s3-bucket-repo/s3-prefix',
        onlyUpdateVersion: true,
      }
    ]
  ]
}
```

---
_Source: https://npm.io/package/semantic-release-helm-app · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._