Improve kubernetes-client/gen documentation for {CLIENT_LANGUAGE}.sh
marie-yau opened this issue · comments
It's not clear that the PACKAGE_NAME in the settings files for python.sh (or any language).sh file needs to be specified as "client". Providing an example of the settings file for python-client, python.sh:
Example settings file for python.sh:
export KUBERNETES_BRANCH="master"
export CLIENT_VERSION="8.0.0b1"
export PACKAGE_NAME="client"
Note: For generating the client for any language, the PACKAGE_NAME should be "client".
You can use the latest version for the CLIENT_VERSION. It's displayed here for
the python-client ( https://github.com/kubernetes-client/python ), and similarly
for other language clients.
Will generate a PR to check this in.
Still open @marie-yau , shall I work?
Hi, you can work on it.
Settings to add PACKAGE_NAME for {CLIENT_LANGUAGE}.sh
For generating the client for any language, the PACKAGE_NAME should be "client", along with the latest CLIENT_VERSION.
For python-client
- Add these to python.sh
export KUBERNETES_BRANCH="master"
export CLIENT_VERSION = "9.0.0-snapshot"
export PACKAGE_NAME="client"For C Sharp
- Add these to csharp.sh
export KUBERNETES_BRANCH=v1.13.0
export CLIENT_VERSION=0.0.1
export PACKAGE_NAME="client"For Go
- Add these to go.sh
export KUBERNETES_BRANCH="master"
export CLIENT_VERSION="0.1.0a1"
export PACKAGE_NAME="client"For Haskell
- Add these to haskell.sh
export KUBERNETES_BRANCH="release-1.9"
export CLIENT_VERSION="0.1"
export PACKAGE_NAME="client"For Java
- Add these to java.sh
export KUBERNETES_BRANCH="release-1.13"
export CLIENT_VERSION="5.0-SNAPSHOT"
export PACKAGE_NAME="client"For Javascript
- Add these to javascript.sh
export KUBERNETES_BRANCH="release-1.13"
export CLIENT_VERSION="0.8-SNAPSHOT"
export PACKAGE_NAME="@kubernetes/node-client"For Ruby
- Add these to ruby.sh
export KUBERNETES_BRANCH="release-1.13"
export CLIENT_VERSION="1.0.0-alpha2"
export PACKAGE_NAME="client"@marie-yau is this fine? I'll add this to the doc :)
/assign roycaihw
/assign marie-yau
My branch: https://github.com/Sai-Adarsh/gen
@marie-yau could you review the PR?
it looks like the documentation improvement has been merged in #86. @marie-yau Is there any change that need to be made?
it looks like the documentation improvement has been merged in #86. @marie-yau Is there any change that need to be made?
It's an example of settings file for python-client. I guess the task is to write similar documentation for all language clients?
@Sai-Adarsh the pattern is similar for different languages and there seems to be no language-specific setting (as #85 (comment) shows). I suppose mentioning "similarly for other language clients" is sufficient?
Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close.
Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale
Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with /close.
Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten
Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.
Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close
@fejta-bot: Closing this issue.
In response to this:
Rotten issues close after 30d of inactivity.
Reopen the issue with/reopen.
Mark the issue as fresh with/remove-lifecycle rotten.Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.