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.

Sign up for GitHub

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

Jump to bottom

Update to Testgrid Documentation #13670

Merged
merged 1 commit into from
Jul 31, 2019
Merged

Update to Testgrid Documentation #13670

merged 1 commit into from
Jul 31, 2019

Conversation

chases2
Copy link
Contributor

@chases2 chases2 commented Jul 29, 2019

Required updates due to how sharding configuration affects workflow [#13541]

Also includes documentation on Configurator, including the not-yet-merged enhancement at #13636
The example in that document is the use case for #13455

/hold
/cc @michelle192837
/cc @spiffxp

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 29, 2019
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. area/config Issues or PRs related to code in /config area/testgrid sig/testing Categorizes an issue or PR as relevant to SIG Testing. labels Jul 29, 2019
spiffxp
spiffxp reviewed Jul 29, 2019
View reviewed changes
Copy link
Member

@spiffxp spiffxp left a comment

Choose a reason for hiding this comment

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

Overall looks good, a few nits and thoughts

testgrid/build_test_update.md Outdated Show resolved Hide resolved
testgrid/config.md Outdated Show resolved Hide resolved
testgrid/build_test_update.md Outdated Show resolved Hide resolved
testgrid/cmd/configurator/README.md Outdated Show resolved Hide resolved
testgrid/cmd/configurator/README.md Outdated Show resolved Hide resolved
testgrid/cmd/configurator/README.md Outdated Show resolved Hide resolved
testgrid/config.md Outdated Show resolved Hide resolved
testgrid/config.md Outdated
@@ -113,7 +113,7 @@ dashboard_groups:

## Testing your configuration

Run `bazel test //testgrid/...` to ensure the config is valid.
Run `bazel test //testgrid/...` to ensure the [configuration] is valid.
Copy link
Member

Choose a reason for hiding this comment

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

really this is this is the testgrid.k8s.io configuration

Copy link
Member

Choose a reason for hiding this comment

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

It may be neat to move the testgrid config validation tests to config/tests/testgrids at some point so that bazel test //config/... enforces all of our conventions; right now what we have in //testgrid/... is a combination of validation and convention enforcement

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added an issue: #13690
After writing it, I think I could just do this while I write the extra testing for Configurator: #13638

testgrid/config.md Outdated
@@ -44,7 +44,7 @@ This functionality is provided by [Configurator](cmd/configurator).
If you need to create a new dashboard, or do anything more advanced, read on.

## Configuration
Open [`config.yaml`] in your favorite editor and:
Open or create a [Testgrid config file][configuration] in your favorite editor and:
Copy link
Member

Choose a reason for hiding this comment

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

I almost wonder if this Configuration section should be moved to /config/testgrid/README.md to talk about the mechanics of changing configuration for testgrid.k8s.io vs. testgrid itself

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It did occur to me that /config/testgrids/README.md should contain cluster-specific config information, while the /testgrid/* readmes should be more general, but that's tough to do because there's the cluster-specific tests still bundled in Configurator

@chases2
Update to Testgrid Documentation
b620f17 
Required updates due to sharding configuration
@chases2
Copy link
Contributor Author

chases2 commented Jul 30, 2019

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 30, 2019
@spiffxp
Copy link
Member

spiffxp commented Jul 31, 2019

/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 31, 2019
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: fdc71c4af6761391eb7f10192ec6d775e0543e53

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chases2, spiffxp

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 31, 2019
@k8s-ci-robot k8s-ci-robot merged commit 48c9c0f into kubernetes:master Jul 31, 2019
@k8s-ci-robot k8s-ci-robot added this to the v1.16 milestone Jul 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@spiffxp spiffxp spiffxp left review comments

@michelle192837 michelle192837 Awaiting requested review from michelle192837

Assignees

@spiffxp spiffxp

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/config Issues or PRs related to code in /config area/testgrid cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/testing Categorizes an issue or PR as relevant to SIG Testing. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
v1.16
Development

Successfully merging this pull request may close these issues.
3 participants
@chases2 @spiffxp @k8s-ci-robot