feat(hydrator): Commit message templating (#23679) #24204
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: pbhatnagar-oss <[email protected]>
Signed-off-by: pbhatnagar-oss <[email protected]>
Signed-off-by: pbhatnagar-oss <[email protected]>
Signed-off-by: pbhatnagar-oss <[email protected]>
…t-message-templating
❌ Preview Environment deleted from BunnyshellAvailable commands (reply to this comment):
|
…ed files Signed-off-by: pbhatnagar-oss <[email protected]>
controller/hydrator/hydrator.go
Outdated
Comment on lines
453
to
455
| if tmpl == "" { | ||
| return "", errors.New("failed to get hydrated commit message template, template not defined") | ||
| } |
There was a problem hiding this comment.
Let's drop this check. An empty template is still a template. We can just pass it on to the renderer to handle.
util/hydrator/hydrator.go
Outdated
|
|
||
| // GetHydratorCommitMetadata takes repo, drySha and commitMetadata and returns a HydratorCommitMetadata which is a | ||
| // common contract controller and commitServer | ||
| func GetHydratorCommitMetadata(repoUrl, drySha string, dryCommitMetadata *appv1.RevisionMetadata) (*HydratorCommitMetadata, error) { //nolint:revive //FIXME(var-naming) |
There was a problem hiding this comment.
Can this just return the struct instead of a pointer? Saves callers from worrying about nil pointer checks.
util/hydrator/template.go
Outdated
|
|
||
| // Render use a parsed template and calls the Execute to apply the data. | ||
| // currently the method supports struct and a map[string]any as data | ||
| func Render(tmpl string, data any) (string, error) { |
There was a problem hiding this comment.
Let's change this function to accept the hydrator metadata struct instead of any, since that's the only use case for now. That'll let us remove all the reflection stuff below.
util/settings/settings.go
Outdated
Comment on lines
1011
to
1015
| label := argoCDCM.Data[settingsSourceHydratorCommitMessageTemplateKey] | ||
| if label == "" { | ||
| return "", nil | ||
| } | ||
| return label, nil |
There was a problem hiding this comment.
Suggested change
| label := argoCDCM.Data[settingsSourceHydratorCommitMessageTemplateKey] | |
| if label == "" { | |
| return "", nil | |
| } | |
| return label, nil | |
| return argoCDCM.Data[settingsSourceHydratorCommitMessageTemplateKey], nil |
A bit simpler
controller/hydrator/hydrator.go
Outdated
| // 1. Get the commit message template defined in the configMap | ||
| // 2. Get the data template engine would use to render the template | ||
| // 3. Pass the output of Step 1 and Step 2 to template Render | ||
| func (h *Hydrator) getHydratorCommitMessage(repoURL, revision string, dryCommitMetadata *appv1.RevisionMetadata) (string, error) { |
There was a problem hiding this comment.
I'd rename this just getCommitMessage. We're already in the hydrator code.
controller/hydrator/hydrator.go
Outdated
Comment on lines
449
to
452
| tmpl, errTemplate := h.dependencies.GetHydratorCommitMessageTemplate() | ||
| if errTemplate != nil { | ||
| return "", fmt.Errorf("failed to get hydrated commit message template %w", errTemplate) | ||
| } |
There was a problem hiding this comment.
Can we move this to the caller and make this function a plain function instead of a receiver? That'll make it easier to unit test.
Co-authored-by: Michael Crenshaw <[email protected]> Signed-off-by: pbhatnagar-oss <[email protected]>
Co-authored-by: Michael Crenshaw <[email protected]> Signed-off-by: pbhatnagar-oss <[email protected]>
Signed-off-by: pbhatnagar-oss <[email protected]>
Signed-off-by: pbhatnagar-oss <[email protected]>
Signed-off-by: pbhatnagar-oss <[email protected]>
14 tasks
Signed-off-by: Michael Crenshaw <[email protected]>
util/hydrator/template.go
Outdated
| delete(sprigFuncMap, "env") | ||
| delete(sprigFuncMap, "expandenv") | ||
| delete(sprigFuncMap, "getHostByName") | ||
| sprigFuncMap["kindIs"] = kindIs |
There was a problem hiding this comment.
Let's remove this, it shouldn't be needed.
Signed-off-by: pbhatnagar-oss <[email protected]>
crenshaw-dev
changed the title
util/settings/settings.go
Outdated
| @@ -45,6 +45,21 @@ import ( | |||
| tlsutil "github.com/argoproj/argo-cd/v3/util/tls" | |||
| ) | |||
|
|
|||
| var commitMessageTemplate = `{{ .metadata.subject }} | |||
There was a problem hiding this comment.
Can we expose this as a public var and use it in the other places where we have this template hardcoded (i.e. tests)?
Co-authored-by: Michael Crenshaw <[email protected]> Signed-off-by: pbhatnagar-oss <[email protected]>
…t-message-templating Signed-off-by: pbhatnagar-oss <[email protected]> # Conflicts: # docs/user-guide/source-hydrator.md
…/argo-cd into commit-message-templating
Signed-off-by: pbhatnagar-oss <[email protected]>
Signed-off-by: pbhatnagar-oss <[email protected]>
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## master #24204 +/- ##
==========================================
+ Coverage 60.23% 60.30% +0.06%
==========================================
Files 348 350 +2
Lines 59872 59959 +87
==========================================
+ Hits 36063 36157 +94
+ Misses 20918 20909 -9
- Partials 2891 2893 +2 ☔ View full report in Codecov by Sentry. |
manifests/base/config/argocd-cm.yaml
Outdated
Comment on lines
119
to
137
| ### SourceHydrator commit message template. | ||
| # This template iterates through the fields in the `.metadata` object, | ||
| # and formats them based on their type (map, array, or primitive values). | ||
| # This is the default template and targets specific metadata properties. | ||
| sourceHydrator.commitMessageTemplate: | | ||
| {{ .metadata.subject }} | ||
| {{- if .metadata.body }} | ||
| {{ .metadata.body }} | ||
| {{- end }} | ||
| {{ range $ref := .metadata.references }} | ||
| {{- if and $ref.commit $ref.commit.author }} | ||
| Co-authored-by: {{ $ref.commit.author }} | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- if .metadata.author }} | ||
| Co-authored-by: {{ .metadata.author }} | ||
| {{- end }} | ||
|
|
||
|
|
There was a problem hiding this comment.
Remove this from the base, since the default is now hard-coded in settings.
Co-authored-by: Michael Crenshaw <[email protected]> Signed-off-by: pbhatnagar-oss <[email protected]>
Co-authored-by: Michael Crenshaw <[email protected]> Signed-off-by: pbhatnagar-oss <[email protected]>
Signed-off-by: pbhatnagar-oss <[email protected]>
…/argo-cd into commit-message-templating
…/argo-cd into commit-message-templating Signed-off-by: pbhatnagar-oss <[email protected]>
…/argo-cd into commit-message-templating
Signed-off-by: pbhatnagar-oss <[email protected]>
crenshaw-dev
requested changes
Aug 30, 2025
Co-authored-by: Michael Crenshaw <[email protected]> Signed-off-by: pbhatnagar-oss <[email protected]>
Co-authored-by: Michael Crenshaw <[email protected]> Signed-off-by: pbhatnagar-oss <[email protected]>
Co-authored-by: Michael Crenshaw <[email protected]> Signed-off-by: pbhatnagar-oss <[email protected]>
Signed-off-by: pbhatnagar-oss <[email protected]>
…t-message-templating
crenshaw-dev
approved these changes
Sep 3, 2025
Mangaal
pushed a commit
to Mangaal/argo-cd
that referenced
this pull request
Sep 10, 2025
…24204) Signed-off-by: pbhatnagar-oss <[email protected]> Signed-off-by: Michael Crenshaw <[email protected]> Co-authored-by: Michael Crenshaw <[email protected]> Signed-off-by: Mangaal <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
commit message template for source hydrator. This closes #23679
Checklist: