fix gen-rpc-doc

Makefile

@@ -104,9 +104,8 @@ doc-deps: ## Build the documentation for the local package and all dependencies.
 .PHONY: gen-rpc-doc
 gen-rpc-doc: submodule-init ## Generate rpc documentation
 	cd devtools/doc/rpc-gen && cargo build
-	cd docs/ckb_rpc_openrpc/ && git reset --hard && git clean -fd
-	./target/debug/ckb-rpc-gen rpc/README.md
 	./target/debug/ckb-rpc-gen --json
+	./target/debug/ckb-rpc-gen rpc/README.md
 
 .PHONY: gen-hashes
 gen-hashes: ## Generate docs/hashes.toml

devtools/doc/rpc-gen/Cargo.toml

@@ -10,7 +10,6 @@ repository = "https://github.com/nervosnetwork/ckb"
 
 [dependencies]
 ckb-rpc ={ path = "../../../rpc", version = "= 0.114.0-pre" }
-
 schemars = { git = "https://github.com/chenyukang/schemars", branch = "fix-derive" }
 serde_json = "~1.0"
 tera = "1"

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

@@ -22,18 +22,22 @@ fn dump_openrpc_json() -> Result<(), Box<dyn std::error::Error>> {
         "finished dump openrpc json for version: {:?} 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 version: {:?}", version),
-        ],
-        Some(OPENRPC_DIR),
-    );
-    run_command("git", &["push"], Some(OPENRPC_DIR));
+
+    if is_git_repo_dirty() {
+        // run git commit all changes before generate rpc readme
+        eprintln!("commit OpenRPC changes to repo: {}", get_git_remote_url());
+        run_command("git", &["add", "."], Some(OPENRPC_DIR));
+        run_command(
+            "git",
+            &[
+                "commit",
+                "-m",
+                &format!("update openrpc json for version: {:?}", version),
+            ],
+            Some(OPENRPC_DIR),
+        );
+        run_command("git", &["push"], Some(OPENRPC_DIR));
+    }
     Ok(())
 }
 

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

@@ -67,3 +67,17 @@ pub(crate) fn checkout_tag_branch(version: &str) {
         run_command("git", &["checkout", "-b", version], dir);
     }
 }
+
+pub(crate) fn is_git_repo_dirty() -> bool {
+    let res = run_command("git", &["status", "--porcelain"], Some(OPENRPC_DIR));
+    res.map(|s| !s.is_empty()).unwrap_or(false)
+}
+
+pub(crate) fn get_git_remote_url() -> String {
+    run_command(
+        "git",
+        &["config", "--get", "remote.origin.url"],
+        Some(OPENRPC_DIR),
+    )
+    .map_or("".to_string(), |s| s.trim().to_string())
+}

rpc/src/module/chain.rs

@@ -43,7 +43,7 @@ use std::sync::Arc;
 /// ## Chain Reorganization
 ///
 /// Chain Reorganization happens when CKB found a chain that has accumulated more work than the
-/// canonical chain. The reorganization reverts the blocks in the current canonical chain if needed,
+/// canonical chain. The reorganization revert the blocks in the current canonical chain if needed,
 /// and switch the canonical chain to that better chain.
 ///
 /// ## Live Cell

util/fixed-hash/core/Cargo.toml

@@ -12,10 +12,8 @@ repository = "https://github.com/nervosnetwork/ckb"
 thiserror = "1.0.22"
 serde = { version = "1.0", features = ["derive"] }
 faster-hex = "0.6"
-#schemars = "0.8.12"
 schemars = { git = "https://github.com/chenyukang/schemars", branch = "fix-derive"}
 
 
-
 [dev-dependencies]
 serde_json = "1.0"

util/jsonrpc-types/Cargo.toml

@@ -13,8 +13,6 @@ ckb-types = { path = "../types", version = "= 0.114.0-pre" }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 faster-hex = "0.6"
-
-#schemars = "0.8.12"
 schemars = { git = "https://github.com/chenyukang/schemars", branch = "fix-derive"}
 
 [dev-dependencies]

util/launcher/Cargo.toml

@@ -34,7 +34,6 @@ ckb-light-client-protocol-server = { path = "../light-client-protocol-server", v
 ckb-block-filter = { path = "../../block-filter", version = "= 0.114.0-pre" }
 
 
-
 [features]
 with_sentry = [ "ckb-sync/with_sentry", "ckb-network/with_sentry", "ckb-app-config/with_sentry" ]
 portable = ["ckb-shared/portable"]