GRIN/nym
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Max/individual command autodocs (#5015)

Browse Source 
* auto commit generated command files

* added to autodoc.sh: build all binaries before running

* autodoc move individual command outputs to components
This commit is contained in:
mx
2024-10-22 19:22:05 +00:00
committed by GitHub
parent e0edcd8e57
commit 276d4318be
66 changed files with 6395 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/scripts/next-scripts/autodoc.sh
+14 -9
View File
@@ -1,24 +1,29 @@
#!/bin/bash
# this script is run by the `generate:commands` script in docs/package.json
set -o errexit
set -o nounset
set -o pipefail
# this is run by the `generate:commands` script in docs/package.json
cd ../autodoc && cargo run --release &&
# make sure we have all the binaries built
cd ../../ && cargo build --release &&
mv autodoc-generated-markdown/nym-cli-commands.md ../docs/pages/developers/tools/nym-cli/commands.mdx &&
mv autodoc-generated-markdown/nym-client-commands.md ../docs/pages/developers/clients/websocket/commands.mdx &&
mv autodoc-generated-markdown/nym-socks5-client-commands.md ../docs/pages/developers/clients/socks5/commands.mdx &&
# run autodoc script
cd documentation/autodoc/ && cargo run --release &&
mv autodoc-generated-markdown/nym-cli-commands.md ../docs/pages/developers/tools/nym-cli/commands.mdx &&
mv autodoc-generated-markdown/nym-client-commands.md ../docs/pages/developers/clients/websocket/commands.mdx &&
mv autodoc-generated-markdown/nym-socks5-client-commands.md ../docs/pages/developers/clients/socks5/commands.mdx &&
mv autodoc-generated-markdown/commands/* ../docs/components/outputs/command-outputs/ &&
# commit files to git: needed for remote deployment from branch
if ! git diff --quiet -- "../docs/pages/developers/tools" "../docs/pages/developers/clients/websocket" "../docs/pages/developers/clients/socks5"; then
# commit files to git: needed for remote deployment from branch
if ! git diff --quiet -- "../docs/pages/developers/tools" "../docs/pages/developers/clients/websocket" "../docs/pages/developers/clients/socks5"; then
printf "commiting changes"
git add ../docs/pages/developers/
git commit -m "auto commit generated command files"
git push origin HEAD
else
else
printf "nothing to commit"
fi
fi
cd ../docs