helm / helm/chart-releaser-action

Support for multiple charts_dirs?

Open
#90 0 comments 11 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
668
Forks
222
PR merge metrics
No merged PRs in 30d

Description

Hey everyone,

I’m writing this to get some feedback on an idea I currently have.

TL;DR: How do you, especially the maintainers of the action, think about supporting multiple directories instead of just one charts_dir?

Longer explanation:

We’re currently managing multiple different parts of a software in seperate repositories. Charts are maintained in the same repository as the software they are written for to simplify lockstep releases.

The aim currently is to have one central charts repository to enable users to

  • only need to use one chart repository
  • not clutter the releases of the software with the chart releases

However, to prevent any possible conflicts between charts, we currently sync the charts into the following structure in the charts repository:

charts/
  source_repository_name/
    chart_1/
      Chart.yaml
      templates
    chart_2/
      Chart.yaml
      templates
  another_source_repository/
    chart_3/
      Chart.yaml
      templates

Uniqueness of the chart names can be assumed here, but syncing to one charts directory directly can’t be achieved due to some duplicate file names (of needed files for packaging) on the source_repository_name level.

I tried running the chart-releaser-action on charts/source_repository_name first and then on charts/another_source_repository, this leads to:

  • charts are packaged and released correctly
  • the index.yaml only contains the charts from the source repository for which the last release happened <- this is not what we want.

I think we can avoid that by allowing the specification of multiple charts_dir directories.

What do you think? Any feedback is welcome.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the chart-releaser-action handling of charts_dir and index.yaml, using the multiple source_repository_name directories described in the issue as the test scenario. Done would mean multiple chart directories can be processed without replacing entries from earlier directories in the generated index.yaml.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, kubernetes, shell
Domain
ci-cd, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.