Skip to content
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

chore(components): Updated the index of components #5233

Conversation

Ark-kun
Copy link
Contributor

@Ark-kun Ark-kun commented Mar 3, 2021

No description provided.

@zijianjoy
Copy link
Collaborator

zijianjoy commented Mar 8, 2021

Thank you Alexey for the change! I have a few questions:

  1. Is this change automatically generated with some tool? If so, can we document it in README file so others can help keeping it up-to-date as well?
  2. It is not pointing to the HEAD of master branch, pointing to specific commit ID makes sure that the link to component won't become invalid if component is deleted, but also means that its content can become out-of-date very soon. I am leaning towards using the HEAD of master branch, because it saves the effort of manual update, and keep redirecting users to the latest change, how do you think?

@Ark-kun
Copy link
Contributor Author

Ark-kun commented Mar 11, 2021

  1. Is this change automatically generated with some tool? If so, can we document it in README file so others can help keeping it up-to-date as well?

Yes. The update script is https://github.com/kubeflow/pipelines/blob/master/components/generate_component_index.py in the same directory. I can include information on launching it in the same README.

  1. It is not pointing to the HEAD of master branch, pointing to specific commit ID makes sure that the link to component won't become invalid if component is deleted, but also means that its content can become out-of-date very soon. I am leaning towards using the HEAD of master branch, because it saves the effort of manual update, and keep redirecting users to the latest change, how do you think?

We try to encourage the users to use strict component versioning to increase reproducibility. Apart from deletion, which you've mentioned, another advantage is versioned. Some components are under active development. The component interfaces are sometimes changed. If someone links to the HEAD version, their pipeline may break any time. If the component works for the user, I'm not sure they have a big need to upgrade.
I think that the advantages (stability, reproducibility, control) are important enough to use strict links by default. It's very easy to replace the commit ID with master if the user wants to always be on the cutting edge.
What do you think?

@zijianjoy
Copy link
Collaborator

Yes. The update script is https://github.com/kubeflow/pipelines/blob/master/components/generate_component_index.py in the same directory. I can include information on launching it in the same README.

Thank you for the reference, that is very helpful!

If someone links to the HEAD version, their pipeline may break any time. If the component works for the user, I'm not sure they have a big need to upgrade.

I think this is important enough for using versioned component link, so sounds good on using versioned link. Thank you for explaining!

/lgtm
/approve

@google-oss-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Ark-kun, zijianjoy

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

@google-oss-robot google-oss-robot merged commit 1577bdb into kubeflow:master Mar 11, 2021
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.

5 participants