The `hack/run-in-gopath.sh hack/godep-restore.sh` command shows no progress information and it can take a lot of time, so it's good to mention that if you want to see what is happening, you can use the `-v` flag to turn on verbose mode of `godep restore`.
Searches for how to backport PRs to release branches are difficult if
you don't know what you're looking for. Add a sentence with that word to
make searching easier.
A recent commit in the sig-release repo moved some documentes. These
tombstoned redircts in the community repo haven't yet expired so should
conntinue to work and need updated links.
Signed-off-by: Tim Pepper <tpepper@vmware.com>
On the release team I've seen a number of issues go by this year
where vendor code was updated and later implicated in issue triage
and bisection, but the original commits didn't sufficiently document
the change. Reverting the update then reintroduced a previously
fixed issue, which was insufficiently documented in the changelog. The
subsequent churn led to a lot of work by multiple people to resolve.
Terse godep vendor code update commit messages seem to be the norm and
we should aim higher.
Signed-off-by: Tim Pepper <tpepper@vmware.com>
Some examples have proto tags and some don't. Since proto tags are
generated and not manually written, this commit removes the proto tags
from the examples to remain consistent.
The cherry-pick instruction guide was quite out of date. This
commit dramatically simplifies the doc. Also, based on watching a
new user attempt a cherry pick (a common occurance around release
time with the revolving staffing of the release team), a few
clarification and setup issues are addressed around the
hack/cherry_pick_pull.sh script pre-requisites.
This is an interim fix as the doc will need updated again to capture
the pending prow based method when that becomes preferred and the
file should be merged with the various other branch and release
maintenance documents that are out there.
Signed-off-by: Tim Pepper <tpepper@vmware.com>
Mac OS X was renamed to OS X in 2012, and then renamed again to macOS in 2016.
I suggest that the current name (macOS) should be used whenever referencing the Apple OS.
The extra quotation marks around "Service" are preserved by e2e.go and
e2e.sh and thus cause Ginkgo to skip all tests. It's safe to only
quote just the parameter value for e2e.go, so for example this works
despite the special character:
--test_args="--ginkgo.focus=Secrets|Secrets"
The example about running some tests is in the section on "Testing
against local clusters". Without the --provider=local parameter, it'll
try to use gce.
Understanding the pull request process is central to being a successful
contributor. This commit moves it from the more technical k8s internals
detailed devel/ area over to the guide/ where it will get more
visibility.
This patch just moves the file and leaves a tombstone reminder
behind.
Added a new section in the README for things that are important for
contributors to know, but not something they will use often or at all
but needs to be documented, like owners files.
Linked to documentation team's contribution page.
The go-code.md file is mostly redundant relative to
contributors/devel/development.md and godep.md, the
contributors/guide/coding-conventions.md document and the various
now standard and easily searchable k8s external sources of information
about the Go language.
The redundant links are simply dropped.
The moovweg/gvm link is dropped as the project appears stale with no
releases in years, many open issues, no commits in a year and shows a build
failure in its CI badge.
The emptied go-code.md file is retained, leaving a pointer to the
new location in its place.
Signed-off-by: Tim Pepper <tpepper@vmware.com>
The coding-conventions document covers useful introductory guidance for
all. This commit moves it out of the devel/ detail directory and into the
contributor/guide, fixing up links from other doc's in this repo and
leaving a cookie crumb of a document pointing at the new location.
Signed-off-by: Tim Pepper <tpepper@vmware.com>
The usage of 'godep' is covered in detail in the godep.md. And forked
golang appears to have moved directories.
Signed-off-by: Tim Pepper <tpepper@vmware.com>
The coding advice section had only one bullet, which is golang specific, so
bump that up into the Go section as a sub-bullet.
Signed-off-by: Tim Pepper <tpepper@vmware.com>
- spell out no_parent_owners use case a bit more
- call out that parts of the process are configurable per-repo
- wordsmith reviewer/approver choices to explicitly call out who can
act as each role
- spell out approve plugin configuration
- spell out tide configuration (elide over queries, pretend like it's
entirely repo-centric)
- spell out that tide will rerun presubmit jobs if there are any
configured
- encourage people
k8s-ci-robot
QuaSoft
interma
Srini Brahmaroutu
Joe Julian
Huan Wei
Michael Taufen
Sasha
Sen Lu
Wei Huang
Tim Pepper
Claudia Beresford
Matt Dorn
guineveresaenger
Nikhita Raghunath
wojtekt
Carolyn Van Slyck
Daniel Smith
Pengfei Ni
Jose A. Rivera
austin
ravisantoshgudimetla
Bin Liu
William Zhang
Shubheksha
Zach Arnold
Zach Arnold
johnarok
linyouchong
Alex Glikson
Van Tu
Patrik Erdes
yanxuean
Qingsong Fan
Christoph Blecker
Jeff Chan
Patrick Ohly
jeffchanjunwei
Jorge O. Castro
Brian Grant
Sahdev P. Zala
Loïc Bourgois
Yu-Ju Hong
taoyu27
halfcrazy
Adam Meech
Ayush Pateria
Iris
g-harel
Marek Grabowski
Aaron Crickenberger
Kai Chen