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

Dockerize the application ? #22

Open
accforgithubtest opened this issue Jan 29, 2025 · 3 comments
Open

Dockerize the application ? #22

accforgithubtest opened this issue Jan 29, 2025 · 3 comments
Labels
backlog Backlog of new features and enhancements enhancement New feature or request

Comments

@accforgithubtest
Copy link

Hello, this project look great and thanks for creating this.

Is there a plan to dockerize the application in your roadmap ?
I am thinking that a containerized application, that can take any github/gitlab/gitea/etc projects and generate the architecture diagrams md files would be awesome.

I understand that this is currently a vscode extension that is built only to work with github copilot (which tbh is quite convenient as there is no api keys / etc)

Keen to hear your thoughts on future plans, Cheers!

@ozanani ozanani added enhancement New feature or request backlog Backlog of new features and enhancements labels Jan 31, 2025
@ozanani
Copy link
Member

ozanani commented Jan 31, 2025

@accforgithubtest thank you for the feedback, it's much appreciated 😀

This is a good idea. As you mentioned, Swark is currently built as a VS Code extension and is coupled with the VS Code API, but we can extract the relevant modules and build a standalone app that is using an external LM.

Can you elaborate a bit more on the use cases? do you envision incorporating this in your CI/CD? or having this as a service?

@ozanani ozanani added question Further information is requested and removed backlog Backlog of new features and enhancements labels Jan 31, 2025
@accforgithubtest
Copy link
Author

Yes, CI/CD exactly, to auto generate diagrams for projects as more changes get added in on an ongoing basis.

Ideally I am thinking that this application runs inside a docker container, we provide configurations for various sources, source type (gituhb / gitea / gitlab / etc) along with access tokens for each git url. We also provide it with LLM configs (LLM provider, url, api keys / tokens, etc).
That should provide swark with all the necessary info about the source code repo, as well as LLM configs to connect to LLM's.

The core functionality of how it generates the md files remains the same, only now it will have the ability to interact with code from different locations, and also be able to use different LLM's.

The generated md file can be saved to a mounted docker volume (/output) as a default option.
Another feature even better if it can commit the file to the repo as swark.md assuming the git api access tokens provides it with write access.

@ozanani
Copy link
Member

ozanani commented Feb 1, 2025

@accforgithubtest this is great. There were a few additional requests recently, I'm considering creating a public roadmap so people can vote and we can decide which features to prioritize. Putting this in the backlog for now.

@ozanani ozanani added backlog Backlog of new features and enhancements and removed question Further information is requested labels Feb 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Backlog of new features and enhancements enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants