https://github.com/tada5hi/hevi

https://github.com/tada5hi/hevi

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tada5hi/hevi
• Owner: tada5hi
• Created: 2025-03-06T13:35:27.000Z (7 months ago)
• Default Branch: develop
• Last Pushed: 2025-04-24T12:51:41.000Z (6 months ago)
• Last Synced: 2025-04-26T12:48:37.892Z (6 months ago)
• Language: TypeScript
• Size: 681 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

          
# Hevi 🛳️

Versioner & Releaser for Helm Charts

[![npm version](https://badge.fury.io/js/hevi.svg)](https://badge.fury.io/js/hevi)

[![Master Workflow](https://github.com/Tada5hi/hevi/workflows/CI/badge.svg)](https://github.com/Tada5hi/hevi)

[![Known Vulnerabilities](https://snyk.io/test/github/Tada5hi/hevi/badge.svg?targetFile=package.json)](https://snyk.io/test/github/Tada5hi/hevi?targetFile=package.json)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

> 🚧 **Work in Progress**

>

> This project is currently under active development and is not yet ready for production.

**Table of Contents**

- [Installation](#installation)

- [Usage](#usage)

  - [Versionize](#versionize)

  - [Package](#package)

  - [Push](#push)

## Installation

```bash

npm install hevi --save-dev

```

## Usage

### Versionize

Set version of all helm charts in `` to ``.

```bash

npx hevi versionize  \

  --version  \

  --dryRun

```

#### directory (optional)

- Type: `Positional`

- Default: `.`

- Description: Relative path where helm charts are located.

#### version (optional)

- Type: `String`

- Description: Semver version (x.y.z) otherwise existing version will be patched.

#### dryRun (optional)

- Type: `Boolean`

- Default: `false`

- Description: Commit/Write changes to the file system.

### Package

Package all helm charts in `` to .helm-packages.

```bash

npx hevi package 

```

#### directory (optional)

- Type: `Positional`

- Default: `.`

- Description: Relative path where helm charts are located.

### Push

Push all charts, present in `` and packaged in .helm-packages to remote oci registry.

```bash

npx hevi push  \

    --host  \

    --username  \

    --password 

```

#### directory (optional)

- Type: `Positional`

- Default: `.`

- Description: Relative path where helm charts are located.

#### host

- Type: `String`

- Description: Registry host e.g. ghcr.io

#### username

- Type: `String`

- Description: Registry username

#### password

- Type: `String`

- Description: Registry password