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

[Feature Request]: Please adhere to the best practices of Continuous Integration (CI) for project configuration. #739

Open
1 task done
shaoyie opened this issue May 12, 2024 · 0 comments
Labels

Comments

@shaoyie
Copy link
Contributor

shaoyie commented May 12, 2024

Is there an existing issue for the same feature request?

  • I have checked the existing issues.

Is your feature request related to a problem?

No response

Describe the feature you'd like

How can there be two places, .env and service_conf.yaml, where the same parameters need to be configured, manually synchronized? This is both foolish and prone to errors. Synchronizing multiple configurations, such as this low-level task, should be done through code, not manual operations. Python is perfectly capable of parsing .env files.

More importantly, this approach does not elegantly support CI (Continuous Integration). With your current implementation, I would either have to upload sensitive information like database passwords in the code to the repository or have local code outside the scope of the repository in my local deployment environment, which is quite troublesome to maintain. Whether it's GitHub, Vercel, or many other platforms, they all support configuring environment variables (for example: https://github.com/tiwater/ragflow/settings/environments, https://github.com/tiwater/ragflow/settings/secrets/actions). Only authorized administrators can manage the environment variables in environments, setting truly critical information like database passwords, which can override the default values in .env. Only in this way can we avoid having code outside of repository management, without worrying about issues like database password leaks through code, and seamlessly support the major platforms currently in vogue, achieving CI (continuous integration).

As an open-source project with goals, please actively follow best practices.

Describe implementation you've considered

No response

Documentation, adoption, use case

No response

Additional information

No response

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

No branches or pull requests

2 participants