Skip to content

Conformance Profiles: Badges for Reports #2293

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

Merged

Conversation

shaneutt
Copy link
Member

@shaneutt shaneutt commented Aug 11, 2023

What type of PR is this?

/kind cleanup
/kind documentation
/area conformance

What this PR does / why we need it:

This adds badges for implementations which are reporting conformance. The badges are placed under the organization name on the implementations.md page, and multiple badges can be listed if there are multiple projects. This helps us meet more of the graduation criteria for GEP 1709 to graduate the conformance profiles work to standard.

For now, these badges are simple and manually managed so that we can just have some display layer to start with. We expect that in the future we'll get tired of this and there will be more iterations to automate this process.

Which issue(s) this PR fixes:

Fixes #2286

Does this PR introduce a user-facing change?:

NONE

@shaneutt shaneutt added this to the v1.0.0 milestone Aug 11, 2023
@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. area/conformance-test Issues or PRs related to Conformance tests. labels Aug 11, 2023
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 11, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: shaneutt

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

The pull request process is described here

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 11, 2023
@shaneutt shaneutt changed the title Shaneutt/conformance badges Conformance Profiles: Badges for Reports Aug 11, 2023
@shaneutt shaneutt added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Aug 11, 2023
@shaneutt shaneutt marked this pull request as ready for review August 11, 2023 17:49
@k8s-ci-robot k8s-ci-robot requested review from bowei and mlavacca August 11, 2023 17:49
@shaneutt
Copy link
Member Author

/cc @youngnick @robscott @mlavacca @sunjayBhatia @arkodg @howardjohn @sayboras @michaelbeaumont @kate-osborn

@shaneutt
Copy link
Member Author

It's not the best, but again this is about just starting somewhere, and it's really simple. Here's an example of how it looks:

image

The badges link directly to the relevant report, which isn't "great" for human readability, but we can continue to iterate on this.

@kubernetes-sigs kubernetes-sigs deleted a comment from k8s-ci-robot Aug 11, 2023
Copy link
Member

@robscott robscott left a comment

Choose a reason for hiding this comment

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

Thanks @shaneutt!

@kubernetes-sigs kubernetes-sigs deleted a comment from k8s-ci-robot Aug 11, 2023
@shaneutt shaneutt requested a review from robscott August 11, 2023 17:59
@shaneutt shaneutt added the tide/merge-method-rebase Denotes a PR that should be rebased by tide when it merges. label Aug 11, 2023
@shaneutt shaneutt force-pushed the shaneutt/conformance-badges branch from 1bcb293 to 4881745 Compare August 11, 2023 18:05
Co-authored-by: Rob Scott <rob.scott87@gmail.com>
@shaneutt shaneutt requested a review from kate-osborn August 11, 2023 18:08
@robscott
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 11, 2023
@k8s-ci-robot k8s-ci-robot merged commit f521984 into kubernetes-sigs:main Aug 11, 2023
@shaneutt shaneutt deleted the shaneutt/conformance-badges branch August 14, 2023 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/conformance-test Issues or PRs related to Conformance tests. 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. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. tide/merge-method-rebase Denotes a PR that should be rebased by tide when it merges.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Conformance Profiles: initial display for reports
4 participants