Skip to content

Commit

Permalink
Documentation Update to local TestGrid tests
Browse files Browse the repository at this point in the history
  • Loading branch information
chases2 committed Aug 19, 2019
1 parent 824921f commit 8c4ea95
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 11 deletions.
8 changes: 3 additions & 5 deletions config/testgrids/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@ Any file put in this directory or a subdirectory will be picked up by [testgrid.

## Testing

Run `bazel test //testgrid/...` to ensure the configuration is valid.
Run `bazel test //config/jobs/tests/...` to ensure these configurations are valid.

This finds common problems such as malformed yaml, a tab referring to a
non-existent test group, a test group never appearing on any tab, etc.

Run `bazel test //...` for slightly more advanced testing, such as ensuring that
every job in our CI system appears somewhere in testgrid, etc.
non-existent test group, a test group never appearing on any tab, etc. It also enforces some
repository-specific conventions.
4 changes: 2 additions & 2 deletions testgrid/build_test_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ to verify.

## Testing

Run `bazel test //testgrid/...` to run all unit tests in TestGrid. Note that this also validates
the [testgrid.k8s.io config].
Run `bazel test //testgrid/...` to run all unit tests in TestGrid. Note that this does not validate
the [testgrid.k8s.io config]; those tests are in `bazel test //config/tests/testgrids/...`

Run `bazel test //...` for repository-wide testing, such as ensuring that
every job in our CI system appears somewhere in testgrid, etc.
Expand Down
5 changes: 1 addition & 4 deletions testgrid/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,10 +117,7 @@ dashboard_groups:

## Testing your configuration

Run `bazel test //testgrid/...` to ensure the configuration is valid.

This finds common problems such as malformed yaml, a tab referring to a
non-existent test group, a test group never appearing on any tab, etc.
Run [`bazel test //config/tests/testgrids/..`](/config/tests/testgrids) to ensure the configuration is valid.

## Advanced configuration
See [`config.proto`] for an extensive list of configuration options. Here are some commonly-used ones.
Expand Down

0 comments on commit 8c4ea95

Please sign in to comment.