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

Removal of task list from Porch API #829

Open
ciaranjohnston opened this issue Jan 13, 2025 · 1 comment
Open

Removal of task list from Porch API #829

ciaranjohnston opened this issue Jan 13, 2025 · 1 comment
Labels
area/api area/porch Porch related issues

Comments

@ciaranjohnston
Copy link
Member

Porch APIs are documented here:
https://github.com/nephio-project/porch/blob/main/api/porch/v1alpha1/types.go

The PackageRevisionSpec struct includes parameter "Tasks":
https://github.com/nephio-project/porch/blob/9b4e2265ca04db7466d69ac0266de1cedfdc9d79/api/porch/v1alpha1/types.go#L100

which is an array of the operations performed on the packagerevision. These are essentially a replayable history of the packagerevision. They are only populated by Porch so a packagerevision which is not created by Porch may have an empty task list.

This tasks list seems to be something that either should not be exposed at all over the API (as an internal implementation detail of the package evolution structure) or something that needs to be clearly documented on how it should be populated, manipulated and evolved.

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

Since certain aspects of the task list are used e.g. by PackageVariant a clear alternative needs to be in place (e.g. hidden from the API or well documented and understood, or replaced with a simpler / better parameter).

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
Projects
None yet
Development

No branches or pull requests

1 participant