An open API service indexing awesome lists of open source software.

https://github.com/schemahero/schemahero-helm

A Helm chart for SchemaHero
https://github.com/schemahero/schemahero-helm

Last synced: 12 months ago
JSON representation

A Helm chart for SchemaHero

Awesome Lists containing this project

README

          

# Helm chart for SchemaHero

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/schemahero/schemahero-helm/CI?label=CI%2FCD&style=for-the-badge)
[![Current](https://img.shields.io/github/v/tag/schemahero/schemahero-helm?logo=github&sort=semver&style=for-the-badge&label=current)](https://github.com/schemahero/schemahero-helm/releases/latest)
[![Artifact Hub](https://img.shields.io/endpoint?style=for-the-badge&url=https://artifacthub.io/badge/repository/schemahero)](https://artifacthub.io/packages/helm/schemahero/schemahero)
[![Apache 2.0](https://img.shields.io/github/license/schemahero/schemahero-helm?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)

## Installation

The chart is published to
[GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry)
and requires Helm version to be >= 3.7.0.

1. Enable [OCI support](https://helm.sh/docs/topics/registries/#enabling-oci-support).
```sh
export HELM_EXPERIMENTAL_OCI=1
```

1. Choose appropriate version from the [available releases](https://github.com/schemahero/schemahero-helm/releases).

It's recommended to install the chart into a dedicated namespace.

```sh
helm upgrade -i --wait --create-namespace -n schemahero schemahero \
oci://ghcr.io/schemahero/helm/schemahero --version ${VERSION}
```

## Configuration

Chart parameters can be configured via [Helm values files](https://helm.sh/docs/chart_template_guide/values_files/).

Check out
[values schema](https://artifacthub.io/packages/helm/schemahero/schemahero?modal=values-schema)
for the comprehensive list of available configuration options.

## Create new release

1. Navigate to [Release Workflow](https://github.com/schemahero/schemahero-helm/actions/workflows/release.yaml)
in `Actions` section.
1. Click `Run workflow` button.
1. Wait until job is finished.

Release job performs following actions.

1. Generates changelog from previous release tag.
1. Calculates a new release version from the changelog.
1. Creates new GitHub release with git tag containing new release number.
1. Generates Helm chart with assigned version.
1. Publishes Helm chart to GitHub Packages repository.

Release pipeline is powered by
[semantic-release](https://github.com/semantic-release/semantic-release) tool.