0xMiden / 0xMiden/node

Breaking change detection

Đang mở
#1,924 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Rust
Star
104
Fork
138
Merge trung bình
1 ngày 13 giờ
Pull request đã merge (30 ngày)
56

Mô tả

I'd like to have the latest release and the dev branch be the same for longer. That is, not immediately branching off at the moment of release, but rather only on a breaking change.

To facilitate this, I think we can add a rudimentary but effective change detection gh workflow.

This is slightly different to other miden repos since the node is essentially a binary executable and not a library.

imo we have the following api surface:
1. gRPC API external (RPC)
2. node CLI
3. protocol version
4. breaking semantics
5. Docker compose API for local node

Optionally, we could also include internal grpc API in case operators want to mix and match internal component versions. I will argue this is not necessary at this point.

### Workflow outline

- Workflow runs on every PR to next/dev
- Detects possible breaking change
- Adds a warning comment on the PR describing breaks found
- Fails PR unless PR includes opt-out label (same as current changelog workflow)

### Change detection

We can use the following

1. `buf` cli has this built in
2. Git diff on relevant files, or a unit snapshot test which checks the help output of the cli for changes
3. Git diff of lockfile and toml
4. This will have to be manual
5. Git diff

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

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.