From db1d8d09b19dfae9bc5d69e2ef929c003e51907c Mon Sep 17 00:00:00 2001 From: Oli Date: Wed, 29 Oct 2025 15:06:34 +0100 Subject: [PATCH] multi: generate command-generator, fix docs --- .github/workflows/main.yml | 8 +++----- cmd/chantools/zombierecovery_findmatches.go | 2 +- cmd/chantools/zombierecovery_root.go | 6 +++++- doc/chantools_zombierecovery.md | 1 + doc/chantools_zombierecovery_findmatches.md | 2 +- doc/command-generator.html | 14 +++++++------- 6 files changed, 18 insertions(+), 15 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 2a26845..43b81c4 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -28,6 +28,9 @@ jobs: with: fetch-depth: 0 + - name: create linter cache directory + run: mkdir -p /tmp/go-lint-cache + - name: linter cache uses: actions/cache@v4 with: @@ -35,11 +38,6 @@ jobs: /tmp/go-lint-cache key: ${{ runner.os }}-go-${{ env.GO_VERSION }}-linter-${{ hashFiles('**/go.sum') }} - - name: Cache Docker images. - uses: ScribeMD/docker-cache@0.5.0 - with: - key: docker-${{ runner.os }}-${{ hashFiles('**/go.sum') }} - - name: lint run: make lint diff --git a/cmd/chantools/zombierecovery_findmatches.go b/cmd/chantools/zombierecovery_findmatches.go index 2fca190..f89d8ae 100644 --- a/cmd/chantools/zombierecovery_findmatches.go +++ b/cmd/chantools/zombierecovery_findmatches.go @@ -140,7 +140,7 @@ func newZombieRecoveryFindMatchesCommand() *cobra.Command { Use: "findmatches", Short: "[0/3] Matchmaker only: Find matches between " + "registered nodes", - Long: `Match maker only: Runs through all the nodes that have + Long: `Matchmaker only: Runs through all the nodes that have registered their ID on https://www.node-recovery.com and checks whether there are any matches of channels between them by looking at the whole channel graph. diff --git a/cmd/chantools/zombierecovery_root.go b/cmd/chantools/zombierecovery_root.go index baa2abd..1abf0ef 100644 --- a/cmd/chantools/zombierecovery_root.go +++ b/cmd/chantools/zombierecovery_root.go @@ -19,7 +19,11 @@ func newZombieRecoveryCommand() *cobra.Command { to help with recovering funds stuck in zombie channels. Please visit https://github.com/lightninglabs/chantools/blob/master/doc/zombierecovery.md -for more information on how to use these commands.`, +for more information on how to use these commands. + +Check out https://guggero.github.io/chantools/doc/command-generator.html for an +interactive GUI that guides you through the different steps. +`, Run: func(cmd *cobra.Command, args []string) { if len(args) == 0 { _ = cmd.Help() diff --git a/doc/chantools_zombierecovery.md b/doc/chantools_zombierecovery.md index 84b41df..334243e 100644 --- a/doc/chantools_zombierecovery.md +++ b/doc/chantools_zombierecovery.md @@ -13,6 +13,7 @@ for more information on how to use these commands. Check out https://guggero.github.io/chantools/doc/command-generator.html for an interactive GUI that guides you through the different steps. + ``` chantools zombierecovery [flags] ``` diff --git a/doc/chantools_zombierecovery_findmatches.md b/doc/chantools_zombierecovery_findmatches.md index 5b6fdc7..15c2ad0 100644 --- a/doc/chantools_zombierecovery_findmatches.md +++ b/doc/chantools_zombierecovery_findmatches.md @@ -1,6 +1,6 @@ ## chantools zombierecovery findmatches -[0/3] Match maker only: Find matches between registered nodes +[0/3] Matchmaker only: Find matches between registered nodes ### Synopsis diff --git a/doc/command-generator.html b/doc/command-generator.html index 25f29e3..bc46656 100644 --- a/doc/command-generator.html +++ b/doc/command-generator.html @@ -5,28 +5,28 @@ chantools command generator - -