Skip to content

feat(sdk): Add description to upload_pipeline_version in kfp. Part of #6256 #6395

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

Merged

Conversation

casassg
Copy link
Contributor

@casassg casassg commented Aug 19, 2021

Description of your changes:

Part of #6256

@google-oss-robot
Copy link

Hi @casassg. Thanks for your PR.

I'm waiting for a kubeflow member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@google-cla google-cla bot added the cla: yes label Aug 19, 2021
@casassg casassg changed the title feat(sdk): Add description to upload_pipeline_version in kfp feat(sdk): Add description to upload_pipeline_version in kfp (part of #6256) Aug 19, 2021
@@ -1137,7 +1139,8 @@ def upload_pipeline_version(
response = self._upload_api.upload_pipeline_version(
pipeline_package_path,
name=pipeline_version_name,
pipelineid=pipeline_id
pipelineid=pipeline_id,
description=description,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we are using an old version of kfp-server-api, will passing None to this description field break, because there is no description field?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the code, I don't think so. It will be a noop really. It may also be reasonable to ask users to upgrade the server-api to use this as otherwise its pretty much not usable.

https://github.com/kubeflow/pipelines/blob/master/backend/api/python_http_client/kfp_server_api/api/pipeline_upload_service_api.py#L138

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As reported in #6256 (comment), this is actually a breaking change. I'd suggest constructing args to upload_pipeline_version using a dictionary, and then passing the dictionary to the method. In this way, when user does not provide their own description, we can omit the description key altogether.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right, I missed the validation step on line 121. Opened #6472 to do the approach. Let's discuss there how to best handle this

@Bobgy Bobgy changed the title feat(sdk): Add description to upload_pipeline_version in kfp (part of #6256) feat(sdk): Add description to upload_pipeline_version in kfp. Part of #6256 Aug 20, 2021
@Bobgy
Copy link
Contributor

Bobgy commented Aug 20, 2021

Edited title format to conform with our routines

@Bobgy
Copy link
Contributor

Bobgy commented Aug 21, 2021

/lgtm
@chensun can you help with the review too?

@chensun
Copy link
Member

chensun commented Aug 22, 2021

/lgtm
/approve

@google-oss-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chensun

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants