Skip to content

ci: verify example YAML reference headers#4913

Open
JoeyC-Dev wants to merge 1 commit into
kubernetes-sigs:mainfrom
JoeyC-Dev:refAuditWorkflow
Open

ci: verify example YAML reference headers#4913
JoeyC-Dev wants to merge 1 commit into
kubernetes-sigs:mainfrom
JoeyC-Dev:refAuditWorkflow

Conversation

@JoeyC-Dev
Copy link
Copy Markdown
Contributor

@JoeyC-Dev JoeyC-Dev commented May 28, 2026

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

  • Detect changed example YAML and Markdown files in pull requests.
  • Verify #$ reference headers in example YAML files.
  • Report missing, stale, duplicated, and unreferenced example YAML references.
  • Write the verification report to the GitHub Actions job summary.

Note:

  • The check is skipped when neither example YAML files nor reference Markdown files are changed.
  • If only files under examples/ are changed, only the changed example YAML files are checked.
  • If any Markdown file is changed, the full example YAML check runs.
  • Unreferenced example YAML files are reported but do not fail the check.

Demo: (link may not be permanent)
https://github.com/JoeyC-Dev/gateway-api-example-reference-audit-workflow-demo/pulls

Meantime, job that is skipped will report its status as "Success". So the workflow will not block merging if it is being skipped. (src)

Which issue(s) this PR fixes:

N/A

Does this PR introduce a user-facing change?:

NONE

Declaration:
AI was used to help rephrase warning/error messages, review summary (in short, any text/format related part) and to draft the regular expressions.

Signed-off-by: Joey Chen <142381267+JoeyC-Dev@users.noreply.github.com>
@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels May 28, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: JoeyC-Dev
Once this PR has been reviewed and has the lgtm label, please assign danwinship for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 28, 2026
@k8s-ci-robot k8s-ci-robot requested a review from danwinship May 28, 2026 03:57
@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 28, 2026
@k8s-ci-robot k8s-ci-robot requested a review from rikatz May 28, 2026 03:57
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Hi @JoeyC-Dev. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Tip

We noticed you've done this a few times! Consider joining the org to skip this step and gain /lgtm and other bot rights. We recommend asking approvers on your previous PRs to sponsor you.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants