gitea/helm-chart
45
55
Fork 125
Code Issues 32 Pull Requests 8 Actions Releases 87 Activity

Add deprecation fail-safe for Chart templating #269

Merged
luhahn merged 2 commits from justusbunsi/helm-chart:prevent-deprecation-breakage into master 2021-12-22 16:25:34 +00:00
Conversation 6 Commits 2 Files Changed 3 +46
justusbunsi commented 2021-12-21 13:10:37 +00:00
Member
Copy Link

With release 5.0.0 there are so many deprecations and breaking changes
that it is probably a good way to assist the users with values migration
before breaking their environments.

This adds another template file that doesn't render anything but ensures
the removal of dropped or deprecated settings from customized values
files.

For when it is necessary, this check can be disabled via new setting
checkDeprecation.

With release 5.0.0 there are so many deprecations and breaking changes that it is probably a good way to assist the users with values migration before breaking their environments. This adds another template file that doesn't render anything but ensures the removal of dropped or deprecated settings from customized values files. For when it is necessary, this check can be disabled via new setting `checkDeprecation`.
justusbunsi added this to the 5.0.0 milestone 2021-12-21 13:10:37 +00:00
luhahn approved these changes 2021-12-21 14:47:06 +00:00
luhahn left a comment
Member
Copy Link

LGTM build will succeed if #240 and #268 are merged

LGTM build will succeed if #240 and #268 are merged
nmasse-itix commented 2021-12-21 17:23:16 +00:00
Contributor
Copy Link

I'm merging this PR and PR #268 in an integration branch to play with them.

When running the "helm template" command, I get an error:

Error: template: templates/gitea/deprecation.yaml:24:16: executing "templates/gitea/deprecation.yaml" at <.Values.gitea.cache.builtIn>: nil pointer evaluating interface {}.builtIn

Before digging too much into this, do you have any clue why it fails ? Does it work on your side ?

I'm merging this PR and PR #268 in an integration branch to play with them. When running the "helm template" command, I get an error: ``` Error: template: templates/gitea/deprecation.yaml:24:16: executing "templates/gitea/deprecation.yaml" at <.Values.gitea.cache.builtIn>: nil pointer evaluating interface {}.builtIn ``` Before digging too much into this, do you have any clue why it fails ? Does it work on your side ?
justusbunsi commented 2021-12-21 17:38:08 +00:00
Author
Member
Copy Link

I'm merging this PR and PR #268 in an integration branch to play with them.

When running the "helm template" command, I get an error:

Error: template: templates/gitea/deprecation.yaml:24:16: executing "templates/gitea/deprecation.yaml" at <.Values.gitea.cache.builtIn>: nil pointer evaluating interface {}.builtIn

Before digging too much into this, do you have any clue why it fails ? Does it work on your side ?

I'm guessing its a side-effect from the not yet merged #268. I have a similar error when just commenting out the gitea.cache.builtIn without having changed any access to it. Similar failure in Drone build.

> I'm merging this PR and PR #268 in an integration branch to play with them. > > When running the "helm template" command, I get an error: > > ``` > Error: template: templates/gitea/deprecation.yaml:24:16: executing "templates/gitea/deprecation.yaml" at <.Values.gitea.cache.builtIn>: nil pointer evaluating interface {}.builtIn > ``` > > Before digging too much into this, do you have any clue why it fails ? Does it work on your side ? I'm guessing its a side-effect from the not yet merged #268. I have a similar error when just commenting out the `gitea.cache.builtIn` without having changed any access to it. Similar failure in Drone build.
luhahn commented 2021-12-21 17:38:12 +00:00
Member
Copy Link

@nmasse-itix good catch. I saw the error as well and ignored it because i did not rebase onto 240/268. However the error comes up because .Values.gitea.cache does not exist anymore and we try to go even deeper down to builtIn.

@nmasse-itix good catch. I saw the error as well and ignored it because i did not rebase onto 240/268. However the error comes up because .Values.gitea.cache does not exist anymore and we try to go even deeper down to builtIn.
luhahn requested changes 2021-12-21 17:38:42 +00:00
luhahn left a comment
Member
Copy Link

.Values.gitea.cache.builtIn needs .Values.gitea.cache to be checked first

.Values.gitea.cache.builtIn needs .Values.gitea.cache to be checked first
luhahn requested changes 2021-12-21 17:46:32 +00:00
templates/gitea/deprecation.yaml Outdated
@ -0,0 +24,4 @@
{{- if .Values.gitea.cache.builtIn -}}
{{- fail "`gitea.cache.builtIn` does no longer exist. Please use `memcached` at root level instead." -}}
{{- end -}}
{{- if .Values.database.builtIn -}}
luhahn commented 2021-12-21 17:46:06 +00:00
Member
Copy Link

this should be .Values.gitea.database -> the gitea is missing

this should be .Values.gitea.database -> the gitea is missing
justusbunsi marked this conversation as resolved
templates/gitea/deprecation.yaml Outdated
@ -0,0 +25,4 @@
{{- fail "`gitea.cache.builtIn` does no longer exist. Please use `memcached` at root level instead." -}}
{{- end -}}
{{- if .Values.database.builtIn -}}
{{- fail "`database.builtIn` does no longer exist. Builtin databases can be configured inside the dependencies itself. Please refer to the changelog." -}}
luhahn commented 2021-12-21 17:46:29 +00:00
Member
Copy Link

this should do the trick:

  {{/* BUILTIN */}}
  {{- if .Values.gitea.cache -}}
    {{- if .Values.gitea.cache.builtIn -}}
      {{- fail "`gitea.cache.builtIn` does no longer exist. Please use `memcached` at root level instead." -}}
    {{- end -}}
  {{- end -}}
  {{- if .Values.gitea.database -}}
    {{- if .Values.gitea.database.builtIn -}}
      {{- fail "`database.builtIn` does no longer exist. Builtin databases can be configured inside the dependencies itself. Please refer to the changelog." -}}
    {{- end -}}
  {{- end -}}
{{- end -}}
this should do the trick: ```yaml {{/* BUILTIN */}} {{- if .Values.gitea.cache -}} {{- if .Values.gitea.cache.builtIn -}} {{- fail "`gitea.cache.builtIn` does no longer exist. Please use `memcached` at root level instead." -}} {{- end -}} {{- end -}} {{- if .Values.gitea.database -}} {{- if .Values.gitea.database.builtIn -}} {{- fail "`database.builtIn` does no longer exist. Builtin databases can be configured inside the dependencies itself. Please refer to the changelog." -}} {{- end -}} {{- end -}} {{- end -}} ```
justusbunsi marked this conversation as resolved
justusbunsi commented 2021-12-21 17:59:15 +00:00
Author
Member
Copy Link

Why is ci passing? The logs clearly state linting failures. ?

Why is ci passing? The logs clearly state linting failures. ?
justusbunsi commented 2021-12-21 18:11:35 +00:00
Author
Member
Copy Link

Why is ci passing? The logs clearly state linting failures. ?

For the record: Helm changed the behavior with https://github.com/helm/helm/issues/8973. I used an older helm version locally and it failed. Newer versions just log that as info.

> Why is ci passing? The logs clearly state linting failures. ? For the record: Helm changed the behavior with https://github.com/helm/helm/issues/8973. I used an older helm version locally and it failed. Newer versions just log that as info.
justusbunsi force-pushed prevent-deprecation-breakage from a7668fdf9e to fc5716bd4d 2021-12-21 18:18:14 +00:00 Compare
luhahn approved these changes 2021-12-21 18:18:43 +00:00
luhahn left a comment
Member
Copy Link

All good now :)

All good now :)
justusbunsi commented 2021-12-21 18:21:30 +00:00
Author
Member
Copy Link

Thanks @nmasse-itix for digging into this PR. There was a lot more to fix.

Thanks @nmasse-itix for digging into this PR. There was a lot more to fix.
👍 1
wxiaoguang approved these changes 2021-12-22 16:19:32 +00:00
luhahn merged commit c27140c4cb into master 2021-12-22 16:25:34 +00:00
justusbunsi deleted branch prevent-deprecation-breakage 2021-12-22 16:32:31 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
luhahn
wxiaoguang
Labels
Clear labels   
has
backport

  
in progress

   
invalid
  
kind
breaking

  
kind
bug

  
kind
build

  
kind
dependency

  
kind
deployment

  
kind
docs

  
kind
enhancement

  
kind
feature

  
kind
lint

  
kind
proposal

  
kind
question

  
kind
refactor

  
kind
security

  
kind
testing

  
kind
translation

  
kind
ui

  
need
backport

  
priority
critical

  
priority
low

  
priority
maybe

  
priority
medium

  
reviewed
duplicate

  
reviewed
invalid

  
reviewed
wontfix

  
skip-changelog
  
status
blocked

  
status
needs-feedback

  
status
needs-reviews

  
status
wip

  
upstream
gitea

  
upstream
other

No Label
has
backport
in progress
invalid
kind
breaking
kind
bug
kind
build
kind
dependency
kind
deployment
kind
docs
kind
enhancement
kind
feature
kind
lint
kind
proposal
kind
question
kind
refactor
kind
security
kind
testing
kind
translation
kind
ui
need
backport
priority
critical
priority
low
priority
maybe
priority
medium
reviewed
duplicate
reviewed
invalid
reviewed
wontfix
skip-changelog
status
blocked
status
needs-feedback
status
needs-reviews
status
wip
upstream
gitea
upstream
other
Milestone
Clear milestone
No items
No Milestone
5.0.0
Assignees
Clear assignees
No Assignees
4 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: gitea/helm-chart#269
No description provided.
Delete Branch "justusbunsi/helm-chart:prevent-deprecation-breakage"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?