-
Notifications
You must be signed in to change notification settings - Fork 674
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.
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
Trim down CRD descriptions #1735
Trim down CRD descriptions #1735
Conversation
Pull Request Test Coverage Report for Build 3975627580
💛 - Coveralls |
f35e5a2
to
e8376d6
Compare
Trim down CRD descriptions to avoid the following apply errors: ``` The CustomResourceDefinition "pytorchjobs.kubeflow.org" is invalid: metadata.annotations: Too long: must have at most 262144 bytes ```
e8376d6
to
92b05c5
Compare
/assign @johnugeorge |
Makefile
Outdated
@@ -1,7 +1,7 @@ | |||
# Image URL to use all building/pushing image targets | |||
IMG ?= kubeflow/training-operator:latest | |||
# CRD generation options | |||
CRD_OPTIONS ?= "crd:generateEmbeddedObjectMeta=true" | |||
CRD_OPTIONS ?= "crd:generateEmbeddedObjectMeta=true,maxDescLen=300" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@johnugeorge I tried to set 300 characters. How about generated CRD descriptions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see that there are some minor unintended line breaks. https://github.com/kubeflow/training-operator/pull/1735/files#diff-f68a63b0953eb712985f398c6c8ae96093830f251ec4ced3865cbe46d41550b3L934 This doesn't seem to be a major concern. Good to go
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I increased it to 400 characters. The unintended line breaks that you pointed out are resolved.
Signed-off-by: Yuki Iwai <yuki.iwai.tz@gmail.com>
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: johnugeorge, tenzen-y 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 |
Signed-off-by: Yuki Iwai yuki.iwai.tz@gmail.com
Trim down CRD descriptions to avoid the following apply errors:
The CustomResourceDefinition "pytorchjobs.kubeflow.org" is invalid: metadata.annotations: Too long: must have at most 262144 bytes
What this PR does / why we need it:
Which issue(s) this PR fixes (optional, in
Fixes #<issue number>, #<issue number>, ...
format, will close the issue(s) when PR gets merged):Fixes #
Checklist: