newrelic / newrelic/release-toolkit

helm: add a chart-changelog action

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

Nobody has claimed this yet.

Dominant language
Go
Stars
4
Forks
9
Avg merge
6m
Merged PRs (30d)
1

Description

It would be great to have a dead-simple action that integrates a generated changelog.yml file into a helm chart changelog annotation, as defined by ArtifactHub.

Ideally, this command should not alter the rest of the Chart.yaml file, meaning it should preserve both comments and the order of entries in the file. Go YAML v3 can do this if you unmarshal entries into a yaml.Node struct, but we can consider other approaches as well.

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 locating the existing Go command or action entry point and its tests, then inspect how Chart.yaml and generated changelog.yml are handled. Done means integrating changelog.yml into the Helm chart changelog annotation while preserving Chart.yaml comments and entry order.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, helm
Domain
devops, release
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.