Skip to content

fix: point to the right doc in formatting#2731

Merged
zakisk merged 1 commit into
tektoncd:mainfrom
filariow:fix-label-value-formatting
May 14, 2026
Merged

fix: point to the right doc in formatting#2731
zakisk merged 1 commit into
tektoncd:mainfrom
filariow:fix-label-value-formatting

Conversation

@filariow
Copy link
Copy Markdown
Contributor

@filariow filariow commented May 14, 2026

The function CleanValueKubernetes from the formatting package is poiting to the wrong documentation.
This change updates the comment only.

Signed-off-by: Francesco Ilario filario@redhat.com

📝 Description of the Change

🔗 Linked GitHub Issue

N/A

🧪 Testing Strategy

  • Unit tests
  • Integration tests
  • End-to-end tests
  • Manual testing
  • Not Applicable

🤖 AI Assistance

AI assistance can be used for various tasks, such as code generation,
documentation, or testing.

Please indicate whether you have used AI assistance
for this PR and provide details if applicable.

  • I have not used any AI assistance for this PR.
  • I have used AI assistance for this PR.

Important

Slop will be simply rejected, if you are using AI assistance you need to make sure you
understand the code generated and that it meets the project's standards. you
need at least know how to run the code and deploy it (if needed). See
startpaac to make it easy
to deploy and test your code changes.

If the majority of the code in this PR was generated by an AI, please add a Co-authored-by trailer to your commit message.
For example:

Co-authored-by: Claude noreply@anthropic.com

✅ Submitter Checklist

  • 📝 My commit messages are clear, informative, and follow the project's How to write a git commit message guide. The Gitlint linter ensures in CI it's properly validated
  • ✨ I have ensured my commit message prefix (e.g., fix:, feat:) matches the "Type of Change" I selected above.
  • ♽ I have run make test and make lint locally to check for and fix any
    issues. For an efficient workflow, I have considered installing
    pre-commit and running pre-commit install to
    automate these checks.
  • 📖 I have added or updated documentation for any user-facing changes.
  • 🧪 I have added sufficient unit tests for my code changes.
  • 🎁 I have added end-to-end tests where feasible. See README for more details.
  • 🔎 I have addressed any CI test flakiness or provided a clear reason to bypass it.
  • If adding a provider feature, I have filled in the following and updated the provider documentation:
    • GitHub App
    • GitHub Webhook
    • Gitea/Forgejo
    • GitLab
    • Bitbucket Cloud
    • Bitbucket Data Center

The function `CleanValueKubernetes` from the `formatting` package is
poiting to the wrong documentation. This change updates the comment only.

Signed-off-by: Francesco Ilario <filario@redhat.com>
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation for the CleanValueKubernetes function in pkg/formatting/k8labels.go to correctly reference Kubernetes label value syntax instead of DNS subdomain names. The listed rules for valid label values were also updated for clarity and accuracy. I have no feedback to provide as there were no review comments.

@filariow filariow force-pushed the fix-label-value-formatting branch from bbefa2b to 3d024e6 Compare May 14, 2026 14:20
@zakisk
Copy link
Copy Markdown
Member

zakisk commented May 14, 2026

/ok-to-test

@codecov-commenter
Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 59.36%. Comparing base (a43ae55) to head (3d024e6).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2731   +/-   ##
=======================================
  Coverage   59.36%   59.36%           
=======================================
  Files         208      208           
  Lines       20626    20626           
=======================================
  Hits        12244    12244           
  Misses       7610     7610           
  Partials      772      772           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@zakisk
Copy link
Copy Markdown
Member

zakisk commented May 14, 2026

/lgtm

Copy link
Copy Markdown

@pipelines-as-code pipelines-as-code Bot left a comment

Choose a reason for hiding this comment

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

Congrats @filariow your PR Has been approved 🎉

✅ Pull Request Approved

Approval Status:

  • Required Approvals: 1
  • Current Approvals: 1

👥 Reviewers Who Approved:

Reviewer Permission Level Approval Status
@zakisk write

📝 Next Steps

  • Ensure all required checks pass
  • Comply with branch protection rules
  • Request a maintainer to merge using the /merge command (or merge it
    directly if you have repository permission).

Automated by the PAC Boussole 🧭

@zakisk zakisk merged commit f05bcd0 into tektoncd:main May 14, 2026
5 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants