interledger / interledger/charts

Automatic versioning for `common` chart

Open
#338 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
3
Forks
0
Avg merge
3m
Merged PRs (30d)
22

Description

At the moment the automatic versioning scheme we are using works well for updating charts in general, but it falls apart in the case where we we make PRs to update the common chart.

The core issue is that since helm unittest cannot easily run unitests in library charts, we had to create separate charts dedicated to the purpose of testing the common library.

This task involves solving this problem by first doing some clean up work, and then by modifying the repository tooling so that it automatically updates the versions version references related to the common chart.

This task can be broken up into several steps.

  1. Rework the tests found in charts/tests/common0unittests so that the same functionality is tested in either charts/examples/singledeployment(needs to be created) or in the sibling multideployment folder.
  2. Modify the scripts under tooling to understand that whenever the common library is being updated, then the version references under charts/examples should be automatically updated as well when we patch the version.

This might not be the most elegant solution, so feel free to propose a different solution.

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 tests in charts/tests/common0unittests and the related charts/examples/multideployment chart. Determine whether the coverage should move into a new charts/examples/singledeployment chart or the sibling chart, then inspect the scripts under tooling for version handling. Done means the common chart behavior remains tested and updates to common also update version references under charts/examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm
Domain
build-system, devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.