Merge pull request #13 from simplyblock-io/sbcli-subrepository

Implemented sbcli repository access to get the latest cli-reference.yaml file

Author: noctarius

.github/workflows/mkdocs.yaml

@@ -40,6 +40,7 @@ jobs:
           ./doc-builder build-image
       - name: "Build Documentation Test"
         run: |
+          ./doc-builder update-repositories
           ./doc-builder build
   dev-deployment:
     if: ${{ github.ref == 'refs/heads/main' }}
@@ -57,6 +58,7 @@ jobs:
         run: |
           sed -i -r "s|(site_url: .*)|\1dev/|g" ./mkdocs.yml
           cat ./mkdocs.yml
+          ./doc-builder update-repositories
           ./doc-builder build
       - name: "Upload Documentation"
         uses: SamKirkland/[email protected]
@@ -84,6 +86,7 @@ jobs:
           echo "RELEASE_NAME=$(echo ${name} | sed -e 's/.*\///g')" >> $GITHUB_ENV
       - name: "Prepare Documentation Deployment: ${{ env.RELEASE_NAME }}"
         run: |
+          ./doc-builder update-repositories
           ./doc-builder deploy ${{ env.RELEASE_NAME }}
       - name: "Create Version Tag: ${{ env.RELEASE_NAME }}"
         run: |

.gitignore

@@ -3,4 +3,5 @@
 site
 venv
 .idea
-docs/reference/cli
+docs/reference/cli
+scripts/sbcli-repo

README.md

@@ -40,6 +40,16 @@ needs to be built using:
 ./doc-builder build-image
 ```
 
+In addition, external repositories have to be checked out, to generate the necessary documentation pages. The
+`doc-builder` simplifies this process with a specific command which either creates an initial checkout or updates the
+repositories to the latest commit.
+
+```bash
+./doc-builder update-repositories
+```
+
+The command can be run at any time to update the external repositories to the latest commit.
+
 ### Serving Content Locally
 
 When building or updating the documentation, it is useful to have a local builder with live updating. Mkdocs supports

doc-builder

@@ -23,6 +23,12 @@ if ! [[ "${JQ}" ]]; then
   exit 1
 fi
 
+GIT=$(command -v git)
+if ! [[ "${GIT}" ]]; then
+  echo "Command git not found. Please install git."
+  exit 1
+fi
+
 function ensure_docker_image() {
   echo -n "Checking docker build image... "
   local image=$(${DOCKER} image ls | ${GREP} ${IMAGE_NAME})
@@ -34,6 +40,21 @@ function ensure_docker_image() {
   exit 1
 }
 
+function update_repositories() {
+  if [ ! -d ./scripts/sbcli-repo ]; then
+    echo "Cloning sbcli repository..."
+    git clone https://github.com/simplyblock-io/sbcli.git ./scripts/sbcli-repo
+  else
+    echo "Updating sbcli repository..."
+    pushd ./scripts/sbcli-repo
+    git reset --hard
+    git pull -f
+    local ret=$?
+    popd
+    exit ${ret}
+  fi
+}
+
 function build_image() {
   docker build -t ${IMAGE_NAME} .
   exit $?
@@ -45,6 +66,16 @@ function serve() {
   exit $?
 }
 
+function gen_sbcli_ref() {
+  if [ ! -d ./scripts/sbcli-repo ]; then
+    echo "The sbcli repository not yet available. Please run ./doc-builder update-sbcli and try again."
+    exit 1
+  fi
+
+  echo "Generating sbcli reference pages..."
+  ${DOCKER} run --rm ${terminal} -v "${PWD}":/docs --entrypoint="/usr/local/bin/python" ${IMAGE_NAME} /docs/scripts/cli-reference-gen.py /docs
+}
+
 function build() {
   ensure_docker_image
   echo -n "Cleaning site directory... "
@@ -57,8 +88,10 @@ function build() {
     terminal="-t"
   fi
 
-  echo "Generating CLI reference pages..."
-  ${DOCKER} run --rm ${terminal} -v "${PWD}":/docs --entrypoint="/usr/local/bin/python" ${IMAGE_NAME} /docs/scripts/cli-reference-gen.py /docs
+  # Generates the markdown files for the sbcli reference pages
+  if ! gen_sbcli_ref; then
+    exit 1
+  fi
 
   echo "Building documentation... "
   if ! ${DOCKER} run --rm ${terminal} -v "${PWD}:/docs" ${IMAGE_NAME} build --strict "$@"; then
@@ -135,10 +168,20 @@ case "$1" in
     deploy "${@:2}"
   ;;
 
+  "update-repositories")
+    update_repositories
+  ;;
+
+  "gen-sbcli-ref")
+    gen_sbcli_ref
+  ;;
+
   *)
     echo "Simplyblock Documentation Builder"
     echo "Available commands:"
     echo "  ./doc-builder build-image              Building required docker image"
+    echo "  ./doc-builder update-repositories      Initialized or updated external repository"
+    echo "  ./doc-builder gen-sbcli-ref            Generates the sbcli reference pages"
     echo "  ./doc-builder serve                    Live serving content changes"
     echo "  ./doc-builder build                    Building static documentation"
     echo "  ./doc-builder deploy {version-name}    Preparing new version deployment "

scripts/cli-reference-gen.py

@@ -69,15 +69,13 @@ def get_description(item):
 
 
 base_path = sys.argv[1]
-with open("%s/scripts/cli-reference.yaml" % base_path) as stream:
+with open("%s/scripts/sbcli-repo/cli-reference.yaml" % base_path) as stream:
     try:
         reference = yaml.safe_load(stream)
 
         for command in reference["commands"]:
             for subcommand in command["subcommands"]:
                 if "arguments" in subcommand:
-                    for argument in subcommand["arguments"]:
-                        argument["required"] = False if "default" not in argument else True
                     arguments = select_arguments(subcommand["arguments"])
                     parameters = select_parameters(subcommand["arguments"])
                     subcommand["arguments"] = arguments