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.

Sign up for GitHub

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 commit metadata reference in Argo CD docs #28250

Merged
merged 4 commits into from
Mar 20, 2025
Merged

Improve commit metadata reference in Argo CD docs #28250

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9104b3a
Improve commit metadata reference in Argo CD docs
andrea-mosk Mar 19, 2025
6a6d0d0
Remove alert for commit_metadata field
andrea-mosk Mar 19, 2025
78fd41f
Synchronize
andrea-mosk Mar 19, 2025
dab2b52
Merge branch 'master' into andrea.moscatelli/adjust-commit-metadata-m…
andrea-mosk Mar 20, 2025
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
8 changes: 4 additions & 4 deletions content/en/continuous_delivery/deployments/argocd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,9 @@ The following resources have been added:
2. The `cd-visibility-template` defines what to send in the request for the `cd-visibility-webhook` service.
3. The `cd-visibility-trigger` defines when to send the notification, and it references the `cd-visibility-template`.

<div class="alert alert-warning">
The call to populate the <code>commit_metadata</code> field is not required. The field is used to enrich the payload with Git information.
If your Argo CD application source is not a defined commit SHA (for example, if you are using Helm repositories), adjust the body by removing that line and the comma in the previous line.
</div>
The `commit_metadata` field is optional and can be used to enrich the deployment with Git information. It should be removed (together with the comma in the previous line) in the following cases:
- You are already syncing your repository information to Datadog (see [Synchronize repository metadata to Datadog][20]).
- Your Argo CD application source does not have a defined commit SHA (for example, if you are using Helm repositories).

After the notification service, trigger, and template have been added to the config map, you can subscribe any of your Argo CD applications to the integration.
Modify the annotations of the Argo CD application by either using the Argo CD UI or modifying the application definition with the following annotations:
Expand Down Expand Up @@ -250,3 +249,4 @@ If notifications are not sent, examine the logs of the `argocd-notification-cont
[17]: https://argo-cd.readthedocs.io/en/stable/user-guide/best_practices/#separating-config-vs-source-code-repositories
[18]: /getting_started/tagging/unified_service_tagging/?tab=kubernetes#configuration-1
[19]: https://argo-cd.readthedocs.io/en/stable/user-guide/resource_hooks/#resource-hooks
[20]: /continuous_delivery/features/code_changes_detection#synchronize-repository-metadata-to-datadog
Loading