# @outcome-co/semantic-release-helm

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

Latest version **1.0.2** (published 2021-06-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @outcome-co/semantic-release-helm
pnpm add @outcome-co/semantic-release-helm
yarn add @outcome-co/semantic-release-helm
bun add @outcome-co/semantic-release-helm
```

## 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 | 1.0.2 |
| Published | 2021-06-25 |
| First published | 2021-06-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 18.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Mihai Plasoianu |
| Maintainers | d-tw |

## Links

- npm: https://www.npmjs.com/package/@outcome-co/semantic-release-helm
- Repository: https://github.com/outcome-co/semantic-release-helm-js
- Homepage: https://github.com/outcome-co/semantic-release-helm-js#readme
- Issues: https://github.com/outcome-co/semantic-release-helm-js/issues
- npm.io page: https://npm.io/package/@outcome-co/semantic-release-helm

## Dependencies (6)

- [zod](https://npm.io/package/zod.md) ^3.2.0
- [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
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.0
- [aggregate-error](https://npm.io/package/aggregate-error.md) ^3.1.0

## Recent versions

- 1.0.2 (latest) — 2021-06-25
- 1.0.1-alpha.1 (alpha) — 2021-06-24
- 1.0.1 — 2021-06-25
- 1.0.0 — 2021-06-24
- 1.0.0-alpha.3 — 2021-06-24
- 1.0.0-alpha.2 — 2021-06-24

## README

# semantic-release-helm-js

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

The `version` and `appVersion` are set to `nextRelease.version`.

## 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>
```

## 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'
      }
    ]
  ]
}
```

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