Expose internal apis by ceriath · Pull Request #2520 · helmfile/helmfile

ceriath · 2026-04-08T09:53:56Z

summary

This PR exposes some internal APIs to be used with tooling built on top of helmfile

Copilot

Pull request overview

This PR exposes previously-internal pkg/app functionality so external tooling can drive Helmfile runs more directly.

Changes:

Export Run.WithPreparedCharts (previously withPreparedCharts) and update all call sites.
Export App.SyncRun (previously sync) for external callers.
Add Run.GetState() and Run.GetHelm() accessors for tooling integrations.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
pkg/app/run.go	Exports chart-preparation wrapper and adds state/helm accessors.
pkg/app/app.go	Updates to new exported API names and exposes `SyncRun`.

Comments suppressed due to low confidence (1)

pkg/app/run.go:64

WithPreparedCharts is now exported but still panics on re-entry, and the panic message references Run.PrepareCharts (which doesn’t exist). For a public API, prefer returning an error instead of panicking. Also, the current sentinel (ReleaseToChart != nil) won’t prevent a second call when prepareChartsIfNeeded returns a nil map (e.g., for skipped commands), so the “only once” guarantee isn’t reliably enforced—consider a separate boolean flag or setting ReleaseToChart to a non-nil empty map to mark it as already invoked.

func (r *Run) WithPreparedCharts(helmfileCommand string, opts state.ChartPrepareOptions, f func() []error) error {
	if r.ReleaseToChart != nil {
		panic("Run.PrepareCharts can be called only once")
	}

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

stale · 2026-04-25T11:50:41Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

This exposes the previously internal functions withPreparedCharts and sync to be used by tooling built on top of helmfile Co-authored-by: Raphael Luba <[email protected]> Signed-off-by: Niklas Ott <[email protected]>

This adds a function to get the current HelmState Co-authored-by: Raphael Luba <[email protected]> Signed-off-by: Niklas Ott <[email protected]>

…reparedCharts Signed-off-by: Niklas Ott <[email protected]>

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

ceriath requested review from aditmeno, itscaro, mumoshu, xiaomudk, yxxhero and zhaque44 as code owners April 8, 2026 09:53

yxxhero requested a review from Copilot April 8, 2026 10:38

Copilot started reviewing on behalf of yxxhero April 8, 2026 10:40 View session

Copilot AI reviewed Apr 8, 2026

View reviewed changes

ceriath force-pushed the expose-internal-apis branch 2 times, most recently from a8c8b29 to b46b268 Compare April 8, 2026 17:21

yxxhero requested a review from Copilot April 8, 2026 23:40

Copilot started reviewing on behalf of yxxhero April 8, 2026 23:40 View session

Copilot AI reviewed Apr 8, 2026

View reviewed changes

Comment thread pkg/app/run.go Outdated

stale Bot added the wontfix This will not be worked on label Apr 25, 2026

yxxhero removed the wontfix This will not be worked on label Apr 26, 2026

ceriath force-pushed the expose-internal-apis branch from b46b268 to abeee9e Compare May 5, 2026 08:07

yxxhero requested a review from Copilot May 5, 2026 08:09

Copilot started reviewing on behalf of yxxhero May 5, 2026 08:15 View session

Copilot AI reviewed May 5, 2026

View reviewed changes

Comment thread pkg/app/run.go Outdated

Comment thread pkg/app/run.go

Comment thread pkg/app/run.go

Comment thread pkg/app/run.go Outdated

Comment thread pkg/app/app.go Outdated

ceriath force-pushed the expose-internal-apis branch from abeee9e to bb812ae Compare May 5, 2026 11:21

ceriath and others added 3 commits May 5, 2026 13:23

feat: expose WithPreparedCharts and SyncRun

95e9078

This exposes the previously internal functions withPreparedCharts and sync to be used by tooling built on top of helmfile Co-authored-by: Raphael Luba <[email protected]> Signed-off-by: Niklas Ott <[email protected]>

feat: expose Helm interface and HelmState

aa8956c

This adds a function to get the current HelmState Co-authored-by: Raphael Luba <[email protected]> Signed-off-by: Niklas Ott <[email protected]>

feat: return an error instead of panicking on multiple calls on WithP…

5feceeb

…reparedCharts Signed-off-by: Niklas Ott <[email protected]>

ceriath force-pushed the expose-internal-apis branch from bb812ae to 5feceeb Compare May 5, 2026 11:23

yxxhero requested a review from Copilot May 5, 2026 13:31

Copilot started reviewing on behalf of yxxhero May 5, 2026 13:32 View session

Copilot AI reviewed May 5, 2026

View reviewed changes

Comment thread pkg/app/run.go

yxxhero requested a review from Copilot May 7, 2026 08:11

Copilot started reviewing on behalf of yxxhero May 7, 2026 08:12 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread pkg/app/run.go

yxxhero approved these changes May 7, 2026

View reviewed changes

yxxhero merged commit 897400d into helmfile:main May 7, 2026
24 checks passed

ceriath deleted the expose-internal-apis branch May 8, 2026 07:49

toyamagu-2021 mentioned this pull request Jun 13, 2026

Add App.WithFileSystem #2638

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Expose internal apis#2520

Expose internal apis#2520
yxxhero merged 3 commits into
helmfile:mainfrom
unwired:expose-internal-apis

ceriath commented Apr 8, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

stale Bot commented Apr 25, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Uh oh!

Conversation

ceriath commented Apr 8, 2026

summary

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

stale Bot commented Apr 25, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants