Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve warning about GitRepo HelmCharts #1067

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/guides/helmreleases.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,13 @@ Charts from Git repositories can be released by declaring a
repository on an interval and expose it as an artifact.

The source-controller can build and expose Helm charts as artifacts
from the contents of the `GitRepository` artifact (more about this
later on in the guide).

**There is one caveat you should be aware of:** to make the
source-controller produce a new chart artifact, the `version` in the
`Chart.yaml` of the chart must be bumped.
from the contents of the `GitRepository` artifact [(more about this
later on in the guide)](#define-a-helm-release).

!!! warning "Arbitrary changes in Git do not produce new charts"
source-controller's `HelmChart` only publishes a new chart artifact when a commit
bumps the `version` field of the `Chart.yaml` referenced from the `GitRepository`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Think that given there is progress on this limitation, it would be worth mentioning it, to not scare people away with something that is going to vanish soon.


An example `GitRepository`:

```yaml
Expand Down