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

Proposal: Move examples to their own repo #4010

Closed
dave-gray101 opened this issue Oct 29, 2024 · 2 comments
Closed

Proposal: Move examples to their own repo #4010

dave-gray101 opened this issue Oct 29, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@dave-gray101
Copy link
Collaborator

dave-gray101 commented Oct 29, 2024

Part of the CI Speedup Project https://github.com/users/dave-gray101/projects/2/views/1

I propose that we create a new repo localai-examples and migrate all existing and future examples to that repo.

Currently, we do not actually run automated tests on any of our examples. This does not seem likely to change at any time soon, as we've got plenty on our plates to work on.

Dependabot is automatically generating PRs and running CI for each individual example. Regardless of if we think it's wise to automatically update the dependencies in those mini-projects without testing or not, I believe it makes the most sense to move them to their own repo, with their own testing, update, and CI policies.

I'm happy to create this myself, or wait for you to create a @mudler / localai-examples.

At the same time that the examples are migrated, I propose we change them to reference released versions of LocalAI rather than master - this is mostly going to be a technical change, but I want to document it here since I think that it's actually better to show that to our users anyway.

@mudler
Copy link
Owner

mudler commented Oct 29, 2024

Yes 💯 ! Examples are really a pain for the CI currently, and makes totally sense have a separate repository. I've created https://github.com/mudler/LocalAI-examples to move the current examples out but we can have also multiple repositories. The only problem I see is keeping these functional, as versions could have been bumped invalidating some of the examples code.

@dave-gray101
Copy link
Collaborator Author

https://github.com/mudler/LocalAI-examples has been updated:

  • Now has all the content from the main repo
  • Has a disclaimer on the top that things may be out of date

#4017 was created to drop them from LocalAI itself. Closing this issue as the proposal itself is pretty settled at this time.

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

No branches or pull requests

2 participants