Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Generate a set of pre-configured scripts

Đang mở
  • Có gì không ổn?
#810 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
28/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
django, fastapi, flask, openapi, python, shell
Lĩnh vực
cli, cloud, devops, tooling

Hướng nghiên cứu

Bắt đầu với luồng bootstrap dựa trên template và entry point harness-generate hiện có, sau đó kiểm tra cách các loại ứng dụng và các ghi đè của người dùng được biểu diễn. Xem lại các yêu cầu đối với README.md của project được tạo. Cần xác định tiêu chí hoàn thành cho việc tạo script, giữ nguyên các script hiện có và ghi lại cách chạy các lệnh frontend hoặc backend được tạo.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

new feature

Currently, cloud-harness is using a template-based file/folder hierarchie to bootstrap an application in a project. The problem is that, we still need to remember or have complex command lines that needs to be written by hand if we want, for example, to run the backend in local. For a flask + fastapi application, we need to remember to run uvicorn, what are the env var we need to pass on the command line. Usually, this is manually written in a README file somewhere on the project repo, but it can be an information sometimes complicated to find back, if written in the first place.

I wonder if it wouldn't be possible to generate some scripts, perhaps 1 by application that could just wrap the command line that needs to be passed on the cli to run the application:

  • for something identified as a frontend application, a run-{name-of-the-frontend-app}.bash file that would just run a yarn install && yarn dev or more elaborated strategy
  • for something identified as a django/python backend application, a run-{name-of-the-backend-app}.bash file that would just run CH_CURRENT_APP_NAME={name-of-the-app} CH_VALUES_PATH=deployment/helm/values.yaml {other-app-depepden-env-var} uvicorn --host 0.0.0.0 --port 8000 main:app
  • for complex setup where port-forwarding is also required to make the local backend communicate with the deployed db, perhaps some scripts. This could be integrated to the bash file running the backend by also providing a set of defaults options/flags to pass to the command line to target the remote db (if applicable).

The generation strategy would consider that if the script doesn't exists, it generates it, but if it does exist, it is not. The idea is to let the user being able to override those files if required (e.g: refine the command use to run the frontend, or modify some env vars)

If we push a little bit this idea, we could also generate files that generates the backend and frontend binding from an openapi specification. This is currently done by harness-generate, and even if it works well for cloud harness project that uses directly openapi specification, it doesn't work well if we use django-ninja for example, or any other kind of not-yet-supported stack. Generating a bash script for the application which is based on its type (this generated script could be part of the application template) would allow us to have a flexible way to accomodate for future evolutions without having to drastically change cloud-harness, only the templates while being flexible as we would be able to modify those scripts for each applications if we really need it.

Having those scripts generated would also allows us to generate a part of the README.md with instructions about how to run the project in a very agnostic way

Ngôn ngữ chính
Python
Star
19
Fork
5
Merge trung bình
11 ngày 20 giờ
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của MetaCell/cloud-harness

Tất cả issue của MetaCell/cloud-harness

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.