Skip to content

Draft: Tooling: Add RPCs description tool and file

Killian Delarue requested to merge nomadic-labs/tezos:killian@rpc_description into master

Context

This merge request adds a script that generates a description of current RPCs. The command make rpc-description runs the script and writes the result into rpc_description.

In addition, it updates the CI so that it fails whenever RPCs are modified but the corresponding changes in rpc_encoding are not committed.

The aim of the merge request is to keep track of the current state of the RPCs. Any changes on RPCs are clearly visible to developers and reviewers.

Manually testing the MR

  • make rpc-description should create/replace rpc_description with the correct description of RPCs

  • The CI should pass if no RPC is changed by the commit and the rpc_description file is untouched

  • The CI should pass if rpc_description changes, due to RPCs updates, are correctly committed.

  • The CI should fail if rpc_description is not correctly written or if it does not correspond to the state of RPCs in the commit

  • Here is an example of a failure case :

  • Here is an other Merge Request using it : !2971 (merged)

Merge request reports