Support to print a command help info

Dockerfile

@@ -26,7 +26,12 @@ RUN apk add --no-cache \
         git \
         openssh-client \
         libc6-compat \
-        libstdc++
+        libstdc++ \
+        curl
+
+RUN curl -L https://github.com/LinuxSuRen/http-downloader/releases/download/v0.0.67/hd-linux-amd64.tar.gz | tar xzv hd && \
+        mv hd /usr/bin/hd && \
+        hd fetch --reset
 
 COPY entrypoint.sh /entrypoint.sh
 COPY --from=builder /workspace/yaml-readme /usr/bin/yaml-readme

README.md

@@ -29,6 +29,12 @@ Flags:
 | `parentname` | The parent directory name. For example, `items/good.yaml`, the parent name is `items`. |
 | `fullpath` | The related file path of each items. |
 
+### Available functions
+
+| Name               | Usage |
+|--------------------|---|
+| `printHelp` | `{{printHelp 'hd'}}` |
+
 ### Ignore particular items
 
 In case you want to ignore some particular items, you can put a key `ignore` with value `true`. Let's see the following sample:

action.yml

@@ -30,18 +30,22 @@ inputs:
     required: false
   push:
     description: 'Indicate if you want to push the changes automatically'
-    default: true
+    default: 'true'
     required: true
+  tool:
+    description: 'The tool name which you want to install'
+    required: false
 runs:
   using: 'docker'
   image: 'Dockerfile'
   args:
-    - ${{ inputs.pattern }}
-    - ${{ inputs.username }}
-    - ${{ inputs.org }}
-    - ${{ inputs.repo }}
-    - ${{ inputs.sortby }}
-    - ${{ inputs.groupby }}
-    - ${{ inputs.output }}
-    - ${{ inputs.template }}
-    - ${{ inputs.push }}
+    - --pattern=${{ inputs.pattern }}
+    - --username=${{ inputs.username }}
+    - --org=${{ inputs.org }}
+    - --repo=${{ inputs.repo }}
+    - --sortby=${{ inputs.sortby }}
+    - --groupby=${{ inputs.groupby }}
+    - --output=${{ inputs.output }}
+    - --template=${{ inputs.template }}
+    - --push=${{ inputs.push }}
+    - --tool=${{ inputs.tool }}

entrypoint.sh

@@ -1,13 +1,60 @@
 #!/bin/sh
 
-yaml-readme -p "$1" --sort-by "$5" --group-by "$6" --template "$8" > "$7"
+while [ $# -gt 0 ]; do
+  case "$1" in
+    --pattern=*)
+      pattern="${1#*=}"
+      ;;
+    --username=*)
+      username="${1#*=}"
+      ;;
+    --org=*)
+      org="${1#*=}"
+      ;;
+    --repo=*)
+      repo="${1#*=}"
+      ;;
+    --sortby=*)
+      sortby="${1#*=}"
+      ;;
+    --groupby=*)
+      groupby="${1#*=}"
+      ;;
+    --output=*)
+      output="${1#*=}"
+      ;;
+    --template=*)
+      template="${1#*=}"
+      ;;
+    --push=*)
+      push="${1#*=}"
+      ;;
+    --tool=*)
+      tool="${1#*=}"
+      ;;
+    *)
+      printf "***************************\n"
+      printf "* Error: Invalid argument.*\n"
+      printf "***************************\n"
+      exit 1
+  esac
+  shift
+done
 
-if [ "$9" = "true" ]
+if [ "$tool" != "" ]
 then
-  git config --local user.email "LinuxSuRen@users.noreply.github.com"
-  git config --local user.name "rick"
+  echo "start to install tool $tool"
+  hd i "$tool"
+fi
+
+yaml-readme -p "$pattern" --sort-by "$sortby" --group-by "$groupby" --template "$template" > "$output"
+
+if [ "$push" = "true" ]
+then
+  git config --local user.email "${username}@users.noreply.github.com"
+  git config --local user.name "${username}"
   git add .
 
-  git commit -m "Auto commit by rick's bot, ci skip"
-  git push https://${2}:${GH_TOKEN}@github.com/${3}/${4}.git
+  git commit -m "Auto commit by bot, ci skip"
+  git push https://${username}:${GH_TOKEN}@github.com/${org}/${repo}.git
 fi

main.go

@@ -7,6 +7,7 @@ import (
 	"html/template"
 	"io/ioutil"
 	"os"
+	"os/exec"
 	"path/filepath"
 	"sort"
 	"strconv"
@@ -106,7 +107,20 @@ func (o *option) runE(cmd *cobra.Command, args []string) (err error) {
 
 	// generate readme file
 	var tpl *template.Template
-	if tpl, err = template.New("readme").Parse(readmeTpl); err != nil {
+	if tpl, err = template.New("readme").Funcs(template.FuncMap{
+		"printHelp": func(cmd string) (output string) {
+			var err error
+			var data []byte
+			if data, err = exec.Command(cmd, "--help").Output(); err != nil {
+				_, _ = fmt.Fprintln(os.Stderr, "failed to run command", cmd)
+			} else {
+				output = fmt.Sprintf(`%s
+%s
+%s`, "```shell", string(data), "```")
+			}
+			return
+		},
+	}).Parse(readmeTpl); err != nil {
 		return
 	}