BUSINESS.md mô tả những quy tắc sản phẩm phải giữ. Nhờ vậy Review đánh dấu được một quy tắc nghiệp vụ bị phá hay một migration rủi ro, chứ không chỉ lỗi trình bày.
Cách hoạt động
Mỗi PR hoặc MR đều nhận một bản review đăng ngay trên đó, và mỗi lần push mới sẽ có review bổ sung.
- PR hoặc MR được mở. Bạn kết nối Git provider và chọn repository một lần, sau đó provider gửi sự kiện tới CloudThinker mỗi khi có PR hoặc MR mới, không cần ai khởi động review. PR và MR ở trạng thái draft được bỏ qua cho tới khi được đánh dấu sẵn sàng review.
- CloudThinker thu thập ngữ cảnh. CloudThinker checkout thay đổi và đọc diff, ticket được liên kết từ phần mô tả (Jira, Linear, Backlog hoặc issue của provider, sau khi bạn thêm extension), và các file liệt kê trong Review đọc những gì.
- Review chạy. Độ sâu tùy theo chế độ review của workspace: Fast, Auto hoặc Advanced. Mỗi lần review tiêu tốn credit; xem mức sử dụng và credit.
- Phát hiện xuất hiện trên PR. Bạn nhận một bình luận tóm tắt cùng các bình luận trên dòng mã. Mỗi phát hiện có mức độ nghiêm trọng (Critical, High, Medium hoặc Low) và một bản sửa đề xuất.
- Lần push mới được review tăng dần. Review chỉ đọc các commit được push sau lần review trước, và kiểm tra xem các phát hiện cũ đã được sửa chưa.
CloudThinker giữ một bản sao riêng của từng repository đã chọn để đọc, và xóa các bản sao đó khi bạn nhấn Remove setup. Secret trong output của công cụ được thay bằng placeholder trước khi model nhìn thấy; xem bảo vệ dữ liệu.
docs/ và Jsonnet trong vendor không được review: không phát hiện nào được đặt vào các file này.
Danh sách đầy đủ các mẫu đường dẫn bị bỏ qua
Danh sách đầy đủ các mẫu đường dẫn bị bỏ qua
Review đọc những gì
Ngoài diff, Review đọc các file sau từ repository của bạn. Tất cả đều không bắt buộc.
Bạn tự viết
BUSINESS.md, và file phải theo một định dạng cố định: xem mô tả quy tắc nghiệp vụ. File không phân tích được, hoặc lớn hơn 200 KB, sẽ bị bỏ qua trong lần review đó, còn phần còn lại của review vẫn chạy.
Review kiểm tra những gì
Mỗi phát hiện thuộc một loại.Bạn có thể làm gì
Provider được hỗ trợ
GitHub, GitLab (GitLab.com hoặc tự host), Bitbucket Cloud, Azure DevOps và AWS CodeCommit. Xem xác thực provider để biết mỗi provider cần gì. Kiểm tra các giới hạn sau trước khi lên kế hoạch triển khai:- Mỗi workspace một provider và một project Azure DevOps. Provider thứ hai, hoặc repository trong project Azure DevOps thứ hai, cần workspace riêng.
- GitLab tự host là instance URL duy nhất bạn nhập được. GitHub Enterprise Server và Bitbucket Data Center không có trong lựa chọn, và một kết nối CodeCommit chỉ bao một AWS account và một region.
- Lệnh bình luận với
@cloudthinker-aikhác nhau theo provider, và AWS CodeCommit chỉ nhận câu hỏi ở cấp cao nhất. Xem mức hỗ trợ theo provider. - Apply fix được liệt kê theo provider trong Xử lý phát hiện; Fix all findings và Merge trong Chạy lại, sửa và merge.
- Tự giải quyết xung đột chạy trên mọi provider trừ Azure DevOps.
@cloudthinker-ai trong bình luận dùng để hỏi, yêu cầu review lại hoặc sửa lỗi, còn @cloudthinker:ignore trong phần mô tả bỏ qua review cho riêng thay đổi đó. Xem mention commands.
Bắt đầu
Thiết lập Review
Kết nối provider, chọn repository và nhận lần review đầu tiên.
Xác thực provider
Token, scope và webhook cho từng Git provider.