Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove files properly on generate cli docs and check errors #943

Merged
merged 2 commits into from
Oct 27, 2022
Merged

Remove files properly on generate cli docs and check errors #943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7639074
Remove files properly on generate cli docs and check errors
Racer159 Oct 25, 2022
2d2ce8f
Merge branch 'master' into hotfix-docs-gen
jeff-mccoy Oct 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions docs/4-user-guide/1-the-zarf-cli/100-cli-commands/_category_.json
View file
Open in desktop

This file was deleted.

27 changes: 0 additions & 27 deletions docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_package_uninstall.md
View file
Open in desktop

This file was deleted.

28 changes: 0 additions & 28 deletions docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_tools_get-admin-password.md
View file
Open in desktop

This file was deleted.

13 changes: 12 additions & 1 deletion src/cmd/internal.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package cmd
import (
"encoding/json"
"fmt"
"os"

"github.com/alecthomas/jsonschema"
"github.com/defenseunicorns/zarf/src/config"
Expand Down Expand Up @@ -41,7 +42,17 @@ var generateCLIDocs = &cobra.Command{
// Don't include the datestamp in the output
rootCmd.DisableAutoGenTag = true
//Generate markdown of the Zarf command (and all of its child commands)
doc.GenMarkdownTree(rootCmd, "./docs/4-user-guide/1-the-zarf-cli/100-cli-commands")
if err := os.RemoveAll("./docs/4-user-guide/1-the-zarf-cli/100-cli-commands"); err != nil {
message.Fatalf("Unable to generate the CLI documentation: %s", err.Error())
}
if err := os.Mkdir("./docs/4-user-guide/1-the-zarf-cli/100-cli-commands", 0775); err != nil {
message.Fatalf("Unable to generate the CLI documentation: %s", err.Error())
}
if err := doc.GenMarkdownTree(rootCmd, "./docs/4-user-guide/1-the-zarf-cli/100-cli-commands"); err != nil {
message.Fatalf("Unable to generate the CLI documentation: %s", err.Error())
} else {
message.SuccessF("Successfully created the CLI documentation")
}
},
}

Expand Down