docs: Add instructions to update & verify scripts #255
Conversation
hack/update-codegen.sh
Outdated
| # | ||
| # Now checkout the appropriate branch for the Kubernetes version that | ||
| # you're building for. For example if you're building for Kubernetes | ||
| # 1.10.0 you would do the following: |
There was a problem hiding this comment.
Can you shorten this to "you would checkout release-1.10"? I don't think we need to explain everything ;)
Also, the tag is wrong.
There was a problem hiding this comment.
Actually you know what, I was wrong on my second point. It's better to checkout the tag as you did, than the branch, as I did.
There was a problem hiding this comment.
Ah didn't see the second comment. Fixing.
indradhanush
force-pushed
the
indradhanush/codegen-docs
branch
2 times, most recently
from
a051039
to
816bf5e
Compare
hack/update-codegen.sh
Outdated
| # | ||
| # Now checkout the appropriate branch for the Kubernetes version that | ||
| # you're building for. For example if you're building for Kubernetes | ||
| # 1.10.0 you would do checkout the kubernetes-1.10.0 branch. |
There was a problem hiding this comment.
Extra "do", and please wrap kubernetes-1.10.0 in backticks 👍
There was a problem hiding this comment.
Fixed the extra "do".
Regarding the backticks, this is a bash comment? Sounds odd to me to add backticks the same way we don't do that in Golang comments. Is there a conventional practice I don't know about?
There was a problem hiding this comment.
I do that in Go comments as well ;)
Not sure if there's an official agreement but I think I've seen others do it as well.
indradhanush
force-pushed
the
indradhanush/codegen-docs
branch
2 times, most recently
from
0c68438
to
dd5f11b
Compare
hack/update-codegen.sh
Outdated
| # | ||
| # Now checkout the appropriate branch for the Kubernetes version that | ||
| # you're building for. For example if you're building for Kubernetes | ||
| # 1.10.0 you would checkout the `kubernetes-1.10.0 branch`. |
There was a problem hiding this comment.
based on using this just now to fix my local setup, the branch name was release-x.x.x
There was a problem hiding this comment.
Thanks @elliott-davis. I've pushed a fix.
indradhanush
force-pushed
the
indradhanush/codegen-docs
branch
from
dd5f11b
to
3adc004
Compare
krnowak
dismissed
asymmetric’s stale review
The issues raised in the review are fixed.
No description provided.