Extension hiện có
GitHub Issues chỉ xuất hiện khi Review provider của bạn là GitHub, và GitLab Issues chỉ xuất hiện khi provider là GitLab.
Chưa hỗ trợ: Jira và Confluence bản Data Center hoặc Server (kết nối Atlassian chỉ hoạt động với Atlassian Cloud), và Azure Boards, vốn chưa có extension. Với các công cụ này, hãy dán tiêu chí chấp nhận vào phần mô tả PR: Review đọc phần mô tả cùng với thay đổi.
Điều kiện tiên quyết
- Review đã kết nối với ít nhất một repository. Xem Thiết lập Review.
- Để kết nối một công cụ quản lý ticket: vai trò Admin của workspace và quyền truy cập More → Workspace settings → Connections. Các vai trò khác thấy nút View thay cho Connect trên các ô. Xem vai trò.
- Một tài khoản trên công cụ quản lý ticket có quyền đọc các project chứa ticket của bạn.
Bật extension
1
Mở mục Extensions
Vào Review → Settings và cuộn tới Extensions (“Link tickets and specs so Review can check changes against them”). Mỗi công cụ quản lý ticket có một ô hiển thị trạng thái.
2
Kết nối công cụ quản lý ticket
3
Tham chiếu ticket trong phần mô tả PR
Đặt liên kết hoặc mã ticket vào phần mô tả PR hoặc MR. Không cần lệnh hay cài đặt nào.
Mã ticket của Jira, Linear và Backlog trông giống nhau. Khi chỉ kết nối một trong ba, mã trần như
OPS-1234 sẽ được tra trên công cụ đó. Khi kết nối nhiều hơn một, reviewer phải thử từng công cụ, và một mã tồn tại ở cả hai nơi có thể khớp nhầm ticket.4
Mở PR và đọc kết quả review
Review chạy như bình thường. Giờ đây phát hiện bao gồm cả những chỗ thay đổi chưa đáp ứng ticket, bên cạnh vấn đề trong chính code.Trạng thái thành công: khi thay đổi bỏ sót một phần của ticket, phát hiện của review nêu rõ phần nào.
Ví dụ
Một phần mô tả PR như sau:Review đọc những gì
- Chỉ phần mô tả. Review quét phần mô tả PR hoặc MR để tìm liên kết và mã ticket.
- Không đọc trong code. Mã ticket nằm trong code block hoặc inline code (
`OPS-1234`) bị bỏ qua, nên các ID ví dụ trong snippet không kích hoạt tra cứu. - Tối đa 20 tham chiếu mỗi PR, lấy từ 65.535 ký tự đầu tiên của phần mô tả. Hãy đặt ticket quan trọng nhất lên đầu.
- Ticket mà kết nối của bạn xem được. Review đọc bằng quyền truy cập của tài khoản đã kết nối, nên ticket trong project mà tài khoản đó không mở được sẽ không có trong review.
- Hiển thị cho workspace của bạn. Nội dung reviewer lấy từ ticket có thể xuất hiện trong phát hiện. Các phát hiện này hiện trong bình luận review trên PR và với bất kỳ ai có quyền truy cập Review trong workspace. Với repository công khai, ai xem được PR cũng đọc được các bình luận đó, nên đừng đưa chi tiết mật vào ticket bạn liên kết ở đó. Xem bảo vệ dữ liệu.
Viết ticket giúp review hiệu quả
- Liệt kê từng tiêu chí chấp nhận trên một dòng riêng. Mỗi tiêu chí trở thành một điểm reviewer kiểm tra được. “Chạy tốt” thì không kiểm tra được; “trả về 429 sau 5 lần thử sai trong 1 phút” thì được.
- Liên kết cả đặc tả, không chỉ ticket. Một trang Confluence chứa hợp đồng API cho reviewer biết chính xác tên trường và mã trạng thái.
- Tham chiếu mọi ticket mà PR đóng. PR sửa hai bug thì nên nêu cả hai.
Khắc phục sự cố
Review không nhắc tới ticket
Review không nhắc tới ticket
Kiểm tra: tham chiếu nằm trong phần mô tả, không chỉ ở tên nhánh hay commit message, và không nằm trong dấu backtick hay code block. Xác nhận ô hiển thị Connected.Cách sửa: sửa phần mô tả, rồi bình luận
@cloudthinker-ai review trên PR để review chạy lại và đọc phần mô tả mới. Trên AWS CodeCommit, hãy push một commit mới lên nhánh nguồn của PR thay vào đó. Xem lệnh mention.Không thấy GitHub Issues hoặc GitLab Issues
Không thấy GitHub Issues hoặc GitLab Issues
Các ô này chỉ xuất hiện với Review provider tương ứng. Trên Bitbucket, Azure DevOps hoặc AWS CodeCommit, hãy dùng Jira, Linear hoặc Backlog.
Các ô hiển thị View thay cho Connect
Các ô hiển thị View thay cho Connect
Chỉ Admin của workspace mới kết nối được công cụ quản lý ticket. Hãy nhờ Admin của workspace kết nối, hoặc đổi vai trò cho bạn. Xem vai trò.
Ô hiển thị Connected nhưng ticket không được đọc
Ô hiển thị Connected nhưng ticket không được đọc
Tài khoản đã kết nối không mở được project chứa ticket đó. Hãy cấp quyền cho tài khoản trong công cụ quản lý ticket, hoặc kết nối lại bằng tài khoản có quyền.
Bước tiếp theo
Lệnh mention
Chạy lại review sau khi bạn cập nhật phần mô tả PR.
Learnings
Đưa quy ước code của nhóm bạn vào mọi lượt review.