Test-infra: document tide

Created on 13 Dec 2017 · 14Comments · Source: kubernetes/test-infra

Tide needs a README with a brief overview we can point anyone too (not just those who wish to develop it) and a quick description of key features like batch testing / merge. we should put some details on configuring it below or perhaps in a seperate (linked) doc.

/area prow
/kind documentation
/assign
/assign @cjwagner
FYI @yutongz
/cc @kargakis @stevekuznetsov

areprow kindocumentation prioritimportant-soon

Source

BenTheElder

👍2

Most helpful comment

These docs would be super helpful!

yutongz on 13 Dec 2017

👍3

All 14 comments

also FYI @mattfarina

side note: @kargakis @cjwagner I think we almost might need to start making the area/prow be area/prow/tide, area/prow/deck... :thinking:

BenTheElder on 13 Dec 2017

+1 to area/prow/*

cblecker on 13 Dec 2017

These docs would be super helpful!

yutongz on 13 Dec 2017

👍3

FYI @spiffxp

BenTheElder on 19 Dec 2017

/priority important-soon

BenTheElder on 8 Mar 2018

What would be the best starting point in the code to be able to interpret the meaning of the fields without any precise knowledge of what tide and prow is?

ingvagabund on 2 May 2018

Controllers for tide are written in tide/tide.go. Config for tide is declared config/tide.go and an example is at config.yaml.

stevekuznetsov on 2 May 2018

Cooking some README atm. Noticing the tide controller also consumes the presubmits part. Feels like it should be in the README as well. I will push additional changes once I get through the code and then sweep it one to n-times to polish it. Any feedback at any point is welcome.

ingvagabund on 4 May 2018

A tide README is added in https://github.com/kubernetes/test-infra/pull/7457 - @ingvagabund please sync with the PR author to avoid duplicating any work.

kargakis on 4 May 2018

Thanks, it will take some time before I will be able to sync. Getting This page is taking way too long to load. error when opening #7457.

ingvagabund on 4 May 2018

Seeing this as well unfortunately but I remember a README was added last time I was able to access it :)

kargakis on 4 May 2018

https://api.github.com/repos/kubernetes/test-infra/pulls/7457 says the PR is based on https://github.com/sebastienvas/k8s-test-infra/commits/required-tests.

Found https://github.com/sebastienvas/k8s-test-infra/blob/required-tests/prow/cmd/tide/README.md

ingvagabund on 4 May 2018

@sebastienvas is #7457 still alive? It seems to contain too many comments. Given I was not able to open the PR I am not familiar with its contain. Do you think it would be possible to separate your README.md and put it into another PR? I can share my notes. WDYT?

ingvagabund on 4 May 2018

Yes the PR is still alive, but right I will create another PR with the documentation.