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

Add ability for examples in SDKs to be built without needing to clone enitre repo #1658

Open
ayildirim21 opened this issue Apr 12, 2024 · 2 comments
Labels
area/sdk enhancement New feature or request

Comments

@ayildirim21
Copy link
Member

ayildirim21 commented Apr 12, 2024

Summary

Currently, in order to facilitate the CI of our SDKs efficiently, we use local references in the dependency management files of the examples. If a user just copies the examples folder without cloning the entire repo and tries to build a docker image, this would lead to an error. We should explore different ways that we can continue to have efficient CI while providing a good experience to new users that do not necessarily want to contribute to the SDK. Another point of discussion as mentioned by @kohlisid is:

Whether we want to expose the Dockerfiles and dependency management files to the user or not.
If they care about the code files only and the Docker/Dependency is just for us, then they probably can be omitted from the structure altogether and we have those template in our script/internal folder to use whenever we need it for the CI.

This issue is meant to track the broader discussion of what we want the Numaflow user experience to be like, while also making it as easy as possible for developers to contribute, as Numaflow continues to grow and be adopted.

Use Cases

When a user is exploring the examples, or just onboarding to the Numaflow platform.


Message from the maintainers:

If you wish to see this enhancement implemented please add a 👍 reaction to this issue! We often sort issues this way to know what to prioritize.

@ayildirim21 ayildirim21 added the enhancement New feature or request label Apr 12, 2024
@ayildirim21
Copy link
Member Author

@ayildirim21
Copy link
Member Author

Another thought is that we should probably move the image-push target outside the examples, as it is used by the CI and not necessarily needed by users that just want to build locally and that probably do not have access to quay.io.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/sdk enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants