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

Re-add docs string to telemetry schema file #5775

Merged
merged 6 commits into from
Jun 19, 2024
Merged

Conversation

shaun-nx
Copy link
Contributor

Proposed changes

This change re-adds the required docs string, /** Data is the product telemetry data of NGINX Ingress Controller. */, to the data.avdl file.

When running the make telemetry-schmea command, this string is removed due to a bug in the generator.
The bug is currently captured in the telemetry-exporter repository: nginx/telemetry-exporter#42

When this string is missing, the validateSchemas build test will fail as shown here: https://gitlab.com/f5/xcdf/code/app/df-schemas/-/jobs/7124238833#L299

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@shaun-nx shaun-nx requested a review from a team as a code owner June 18, 2024 12:25
@shaun-nx
Copy link
Contributor Author

@vepatel vepatel merged commit 99d6a03 into main Jun 19, 2024
77 checks passed
@vepatel vepatel deleted the telemetry/docs-string branch June 19, 2024 13:17
ssrahul96 pushed a commit to ssrahul96/kubernetes-ingress that referenced this pull request Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done 🚀
Development

Successfully merging this pull request may close these issues.

5 participants