...

Source file src/sigs.k8s.io/gateway-api/conformance/apis/v1alpha1/doc.go

Documentation: sigs.k8s.io/gateway-api/conformance/apis/v1alpha1

     1  /*
     2  Copyright 2023 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  // V1alpha1 includes alpha maturity API types and utilities for creating and
    18  // handling the results of conformance test runs. These types are _only_
    19  // intended for use by the conformance test suite OR external test suites that
    20  // are written in Golang and execute the conformance test suite as a Golang
    21  // library.
    22  //
    23  // Note that currently all sub-packages are considered "experimental" in that
    24  // they aren't intended for general use or to be distributed as part of a
    25  // release so there is no way to use them by default when using the Golang
    26  // library at this time. If you don't know for sure that you want to use these
    27  // features, then you should not use them. If you would like to opt into these
    28  // unreleased features use Go build tags to enable them, e.g.:
    29  //
    30  //   $ go test ./conformance/... -args ${CONFORMANCE_ARGS}
    31  //
    32  // Please note that everything here is considered experimental and subject to
    33  // change. Expect breaking changes and/or complete removals if you start using
    34  // them.
    35  
    36  package v1alpha1
    37  

View as plain text