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

feat: mode introduced to conformance report API #2801

Merged
merged 1 commit into from
Feb 23, 2024

Conversation

mlavacca
Copy link
Member

What type of PR is this?

/kind feature
/area conformance

What this PR does / why we need it:

The mode field has been added to the conformance report API. This field makes customization of the implementations' operating mode possible.

Which issue(s) this PR fixes:

Fixes #2739

Does this PR introduce a user-facing change?:

The mode field has been added to the conformance report API. This field makes customization of the implementations' operating mode possible.

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/feature Categorizes issue or PR as related to a new feature. area/conformance labels Feb 22, 2024
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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 Feb 22, 2024
@mlavacca
Copy link
Member Author

/cc @shaneutt @robscott @youngnick

Copy link
Member

@shaneutt shaneutt left a comment

Choose a reason for hiding this comment

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

As I understand it the "mode" was meant to allow us to run entirely different sets of tests and provide different reports for different "modes" under the same organization and project, and therefore under the same ConformanceReport. Don't we need to significantly change the reporting structure here to support multiple modes in a single report?

@mlavacca
Copy link
Member Author

mlavacca commented Feb 22, 2024

As I understand it the "mode" was meant to allow us to run entirely different sets of tests and provide different reports for different "modes" under the same organization and project, and therefore under the same ConformanceReport. Don't we need to significantly change the reporting structure here to support multiple modes in a single report?

That was the initial idea I proposed in the related GEP update. After a few rounds of reviews, we eventually decided to keep the report simpler (with a single mode) and introduced a structured way to keep multiple reports, each specifying a specific mode. An example is in this draft PR, where the table of contents contains multiple rows, each specific to a combination of Gateway API channel, implementation version, and mode.

This way, an implementation can have multiple versions supporting the same Gateway API version, with different combinations of Gateway API channels and operating modes.

Copy link
Member

@shaneutt shaneutt left a comment

Choose a reason for hiding this comment

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

Ah right OK, that rings a bell now.

/approve
/cc @youngnick @robscott

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mlavacca, 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

@robscott
Copy link
Member

Thanks @mlavacca!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 23, 2024
@k8s-ci-robot k8s-ci-robot merged commit 9fb8dc6 into kubernetes-sigs:main Feb 23, 2024
8 checks passed
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 cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Mode field to the ConformanceReport API
4 participants