BReg: migration.review.required lists changes that need no review

Đang mở
#2,766 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
62/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
rust
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Start in crates/registry-bregctl/src/lib.rs, where the migration.review.required message is assembled, and compare its filter with compiler_applicable_without_review in crates/registry-breg/src/package.rs. Reproduce the example access-profile change, then split the message into changes that need review and changes that would apply automatically. Update the BReg change rules under docs/site/ to state which access changes require review; done means bregctl test and bregctl package no longer list automatically applicable changes as review items.

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

Mô tả

area:breg bug

When bregctl test or bregctl package refuses a successor with migration.review.required, the message lists every change that is not a compatible addition. Some of the changes it lists would apply without review.

In crates/registry-bregctl/src/lib.rs, the list is built from every change whose class is not CompatibleAdditive. The gate is compiler_applicable_without_review in crates/registry-breg/src/package.rs, which accepts an AccessOrDisclosureChange without review unless it is a query-inventory-changed change that is not an automatic access-grant change, or it targets an action or a timer.

Example: adding an optional field to an access profile that grants list gave this message:

the successor cannot be applied automatically; the changes to review are:
access-profile-changed at contact.directory-editor; query-inventory-changed
at contact.records.contact.directory-editor.list.

Only query-inventory-changed needed review. Adding the same field without adding it to the profile applied automatically. An operator reading the message would start a reviewed migration for both changes.

Proposal:

  1. List only the changes that need review. Changes that would apply automatically can follow under a separate heading.
  2. Decide whether adding an optional field to a profile that grants list should need a reviewed migration. In this case the field applied automatically only when no access profile granted it, so no caller could read or write it through that profile. The BReg change rules in docs/site/ should then say which access changes need review.
Ngôn ngữ chính
Rust
Star
2
Fork
0
Merge trung bình
9 giờ 48 phút
Pull request đã merge (30 ngày)
151

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

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 registrystack/registry-stack

Tất cả issue của registrystack/registry-stack

Issue tương tự

Thêm issue về Rust

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.