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

Remove upstream, mutators and validators from Repository API specification #830

Open
ciaranjohnston opened this issue Jan 13, 2025 · 2 comments
Labels
area/api area/porch Porch related issues good first issue Good for newcomers

Comments

@ciaranjohnston
Copy link
Member

The porch API spec for a Repository:

https://github.com/nephio-project/porch/blob/cb1b392069de7711bb29c3524d6fc464e991f82a/api/porchconfig/v1alpha1/types.go#L56

includes parameters for "upstream", "mutators" and "validators". Upstream indicates a repository that may be upstream of this one, while mutators and validators are lists of functions to be evaluated any time a package is changed within the repository. These parameters are not currently used and not documented, so should be removed from the API specification. They can be reintroduced as and when a use case requires them.

This issue is a result of a discussion around this user story proposal:
https://docs.google.com/document/d/1d4USe4nOcOQAb0ULCMGSPtC72f0dbV0SguPCPEGYaac/edit?tab=t.0

@ciaranjohnston ciaranjohnston added area/api area/porch Porch related issues labels Jan 14, 2025
@ciaranjohnston
Copy link
Member Author

In kpt files, mutators and validators are defined in the kpt file. These are additional mutators and validators that are executed on every package in addition to the ones defined in the kpt file, although these are not currently supported.

@ciaranjohnston ciaranjohnston added the good first issue Good for newcomers label Jan 14, 2025
@ciaranjohnston
Copy link
Member Author

Check with @efiacor that this is a straightforward issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api area/porch Porch related issues good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant