update doc

Author: chenyukang

devtools/doc/rpc-gen/src/main.rs

@@ -32,9 +32,11 @@ fn get_version() -> String {
     return version;
 }
 
-/// Get git tag from command line
 fn get_commit_sha() -> String {
-    run_command("git", &["rev-parse", "HEAD"], Some(OPENRPC_DIR)).unwrap_or("main".to_string())
+    let res =
+        run_command("git", &["rev-parse", "HEAD"], Some(OPENRPC_DIR)).unwrap_or("main".to_string());
+    eprintln!("commit sha: {:?}", res);
+    res
 }
 
 fn checkout_tag_branch(version: &str) {
@@ -76,6 +78,19 @@ fn dump_openrpc_json() -> Result<(), Box<dyn std::error::Error>> {
         "finished dump openrpc json for tag: {:?} at dir: {:?}",
         version, json_dir
     );
+    // run git commit all changes before generate rpc readme
+    run_command("git", &["add", "."], Some(OPENRPC_DIR));
+    run_command(
+        "git",
+        &[
+            "commit",
+            "-m",
+            &format!("update openrpc json for tag: {:?}", version),
+        ],
+        Some(OPENRPC_DIR),
+    );
+    // git push
+    run_command("git", &["push"], Some(OPENRPC_DIR));
     Ok(())
 }
 

docs/ckb_rpc_openrpc

@@ -4633,7 +4633,7 @@ Response
 }
 ```
 
-RPC Module Subscription that CKB node will push new messages to subscribers.
+RPC Module Subscription that CKB node will push new messages to subscribers, in WebSocket or TCP.
 
 RPC subscriptions require a full duplex connection. CKB offers such connections in the form of
 TCP (enable with `rpc.tcp_listen_address` configuration option) and WebSocket (enable with

rpc/README.md

@@ -8,7 +8,7 @@ use jsonrpc_core::Result;
 use jsonrpc_utils::{pub_sub::PublishMsg, rpc};
 use tokio::sync::broadcast;
 
-/// RPC Module Subscription that CKB node will push new messages to subscribers.
+/// RPC Module Subscription that CKB node will push new messages to subscribers, in WebSocket or TCP.
 ///
 /// RPC subscriptions require a full duplex connection. CKB offers such connections in the form of
 /// TCP (enable with `rpc.tcp_listen_address` configuration option) and WebSocket (enable with