Skip to content

Conversation

mengqiy
Copy link
Member

@mengqiy mengqiy commented Oct 28, 2021

The 1st commit is a pure move of the fn metadata schema.
The 2nd commit updates the schema and the places that reference it.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 28, 2021
@k8s-ci-robot k8s-ci-robot added kind/kep Categorizes KEP tracking issues and PRs modifying the KEP directory sig/cli Categorizes an issue or PR as relevant to SIG CLI. labels Oct 28, 2021
@mengqiy mengqiy force-pushed the krmfnmetadataschema branch from ec0faaa to 7ae6838 Compare October 28, 2021 19:25
@mengqiy
Copy link
Member Author

mengqiy commented Oct 28, 2021

/cc @jeremyrickard

sha256:
description: The degist of the binary that can be used to verify the binary.
type: string
home:
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need this, usage and examples? Do you think they'll often point different places, and if so, why?

Copy link
Member Author

Choose a reason for hiding this comment

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

IMO home is really optional, while usage and examples are required.
usage should be the man page for the function. A pointer to a markdown file should be good.
In kpt project, each function example is self-contained directory. It has some KRM resources as input, fn config and some configuration to test the example. We can ensure the examples always work. IMO we can do something similar here.
WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds reasonable. Let's start with this, and we can evolve it if needed.

@mengqiy mengqiy requested a review from KnVerey December 8, 2021 03:28
@KnVerey
Copy link
Contributor

KnVerey commented Dec 15, 2021

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 15, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: KnVerey, mengqiy

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 15, 2021
@k8s-ci-robot k8s-ci-robot merged commit dbf5b76 into kubernetes:master Dec 15, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.24 milestone Dec 15, 2021
@mengqiy mengqiy deleted the krmfnmetadataschema branch December 22, 2021 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/kep Categorizes KEP tracking issues and PRs modifying the KEP directory lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/cli Categorizes an issue or PR as relevant to SIG CLI. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants