Merge pull request #2292 from shaneutt/shaneutt/conformance-report-hi…

…story-updates Conformance Profiles: Report History Management
kubernetes-sigs · Aug 11, 2023 · 4651e91 · 4651e91
2 parents 1dca4af + 1874c77
commit 4651e91
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 4 deletions.
diff --git a/conformance/results/cilium.yaml → ...ormance/reports/v0.7.1/cilium-cilium.yaml b/conformance/results/cilium.yaml → ...ormance/reports/v0.7.1/cilium-cilium.yaml
diff --git a/conformance/results/istio.yaml → ...rmance/reports/v0.7.1/istio.io-istio.yaml b/conformance/results/istio.yaml → ...rmance/reports/v0.7.1/istio.io-istio.yaml
@@ -1,6 +1,6 @@
 apiVersion: gateway.networking.k8s.io/v1alpha1
 date: "2023-07-24T14:26:14-07:00"
-gatewayAPIVersion: 4c436290f2bfeaeaf0b1a367449e16de3e0addc4
+gatewayAPIVersion: 4c436290f2bfeaeaf0b1a367449e16de3e0addc4 # making an exception to the version for this release, since this was the first release we started submitting reports for.
 implementation:
   contact:
   - '@istio/maintainers'

diff --git a/...s/kong-kubernetes-ingress-controller.yaml → ...1/kong-kubernetes-ingress-controller.yaml b/...s/kong-kubernetes-ingress-controller.yaml → ...1/kong-kubernetes-ingress-controller.yaml
diff --git a/conformance/results/kuma.yaml → conformance/reports/v0.7.1/kumahq-kuma.yaml b/conformance/results/kuma.yaml → conformance/reports/v0.7.1/kumahq-kuma.yaml
diff --git a/conformance/reports/v0.7.1/latest b/conformance/reports/v0.7.1/latest
@@ -0,0 +1 @@
+latest
diff --git a/...nce/results/nginx-kubernetes-gateway.yaml → ....1/nginxinc-nginx-kubernetes-gateway.yaml b/...nce/results/nginx-kubernetes-gateway.yaml → ....1/nginxinc-nginx-kubernetes-gateway.yaml
diff --git a/conformance/results/contour.yaml → ...eports/v0.7.1/projectcontour-contour.yaml b/conformance/results/contour.yaml → ...eports/v0.7.1/projectcontour-contour.yaml
@@ -1,6 +1,6 @@
 apiVersion: gateway.networking.k8s.io/v1alpha1
 date: "2023-07-25T22:11:56Z"
-gatewayAPIVersion: "e9859d057b43d177176a9d3d6b15dbdd27fe7e46"
+gatewayAPIVersion: "e9859d057b43d177176a9d3d6b15dbdd27fe7e46" # making an exception to the version for this release, since this was the first release we started submitting reports for.
 implementation:
   contact:
   - '@projectcontour/maintainers'

diff --git a/geps/gep-1709.md b/geps/gep-1709.md
@@ -522,12 +522,28 @@ profiles:
 
 Implementers can submit their reports upstream by creating a pull request to
 the Gateway API repository and adding new reports to a file specific to their
-implementation's project name:
+implementation's organization and project name:
 
 ```console
-conformance/results/<organization>-<project>.yaml
+conformance/reports/<version>/<organization>-<project>.yaml
 ```
 
+The `<version>` directory in the above refers to the version of Gateway API. The
+`latest` release will include a symlink that points to the latest version
+directory.
+
+For instance:
+
+```console
+conformance/reports/v0.7.1/acme-operator.yaml
+```
+
+> **NOTE**: Implementations **MUST** report for a specific release version
+> (e.g. `v0.7.1`) and not use branches or Git SHAs. Some exceptions will be
+> made for initial reports to help make it easier for implementations to get
+> started, but as we move to standard everyone should be reporting on specific
+> releases.
+
 Creating a pull request to add the `ConformanceReport` will start the
 [certification process](#certification-process).