k8s.io/test-infra@v0.0.0-20240520184403-27c6b4c223d8/config/testgrids/README.md (about)

     1  # Testgrid Configurations
     2  
     3  This readme covers information specific to testgrid.k8s.io and this repository.
     4  See Testgrid's [config.md](/testgrid/config.md) for more information Testgrid config files.
     5  
     6  ## Adding a Prow Job to Testgrid
     7  
     8  Prow Jobs in this repository only need to be [annotated](/testgrid/config.md#prow-job-configuration);
     9  no changes are necessary here unless you are adding a brand new dashboard.
    10  
    11  ## Adding or Changing a Configuration
    12  
    13  Any file put in this directory or a subdirectory will be picked up by [testgrid.k8s.io](https://testgrid.k8s.io).
    14  
    15  To add a new test, perform the following steps under any `.yaml` file in this
    16  directory (including a new one, if desired):
    17  
    18  1.   If writing a presubmit and not using [annotations](/testgrid/config.md#prow-job-configuration),
    19       append a new testgroup under `test_groups`, and specify the name and where to get the log.
    20  1.   Append a new `dashboard_tab` under the dashboard you would like to add the testgroup to,
    21       or create a new `dashboard` and assign the testgroup to the dashboard.
    22       * The testgroup name from a dashboard tab should match the name from a testgroup
    23       * Note that a testgroup can be within multiple dashboards.
    24  1.   Test your new config (`go test ./config/tests`)
    25  
    26  
    27  NOTE: If you're adding a periodic or postsubmit and don't want to specially configure your test
    28  group, you don't need to: [Configurator](/testgrid/cmd/configurator) implicitly assume a testgroup
    29  exists for all periodics and postsubmits. You still need to add presubmits here, and all jobs still
    30  need to be added to a dashboard further down.
    31  
    32  ## Testing
    33  
    34  Run `go test //config/tests` to ensure these configurations are valid.
    35  
    36  This finds common problems such as malformed yaml, a tab referring to a
    37  non-existent test group, a test group never appearing on any tab, etc. It also enforces some
    38  repository-specific conventions. More details about specific tests can be found
    39  in that directory.