Add gendocs ci step

Author: cmoog

.github/workflows/test.yaml

@@ -44,3 +44,17 @@ jobs:
         uses: ./ci/image
         with:
           args: go test ./internal/... ./cmd/...
+  gendocs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/cache@v1
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: generate-docs
+        uses: ./ci/image
+        with:
+          args: ./ci/steps/gendocs.sh

ci/steps/fmt.sh

@@ -1,16 +1,17 @@
 #!/bin/bash
+
+set -euo pipefail
+
 echo "Formatting..."
 
 go mod tidy
 gofmt -w -s .
 goimports -w "-local=$$(go list -m)" .
 
-if [ "$CI" != "" ]; then
-  if [[ $(git ls-files --other --modified --exclude-standard) != "" ]]; then
+if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then
     echo "Files need generation or are formatted incorrectly:"
     git -c color.ui=always status | grep --color=no '\e\[31m'
     echo "Please run the following locally:"
     echo "  ./ci/steps/fmt.sh"
     exit 1
   fi
-fi

ci/steps/gendocs.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+set -euo pipefail
+
+echo "Generating docs..."
+
+cd "$(dirname "$0")"
+cd ../../
+
+go run ./cmd/coder gen-docs ./docs
+
+# remove cobra footer from each file
+for filename in ./docs/*.md; do
+  trimmed=$(head -n -1 "$filename")
+  echo "$trimmed" > $filename
+done
+
+
+if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then
+  echo "Documentation needs generation:"
+  git -c color.ui=always status | grep --color=no '\e\[31m'
+  echo "Please run the following locally:"
+  echo "  ./ci/steps/gendocs.sh"
+  exit 1
+fi

ci/steps/lint.sh

@@ -1,6 +1,8 @@
 #!/bin/bash
 
+set -euo pipefail
+
 echo "Linting..."
 
 go vet ./...
-golint -set_exit_status ./...
+golint -set_exit_status ./...

docs/coder.md

@@ -14,6 +14,7 @@ coder provides a CLI for working with an existing Coder Enterprise installation
 
 ### SEE ALSO
 
+* [coder completion](coder_completion.md)	 - Generate completion script
 * [coder config-ssh](coder_config-ssh.md)	 - Configure SSH to access Coder environments
 * [coder envs](coder_envs.md)	 - Interact with Coder environments
 * [coder login](coder_login.md)	 - Authenticate this client for future operations
@@ -23,4 +24,3 @@ coder provides a CLI for working with an existing Coder Enterprise installation
 * [coder sync](coder_sync.md)	 - Establish a one way directory sync to a Coder environment
 * [coder urls](coder_urls.md)	 - Interact with environment DevURLs
 * [coder users](coder_users.md)	 - Interact with Coder user accounts
-

docs/coder_completion.md

@@ -0,0 +1,63 @@
+## coder completion
+
+Generate completion script
+
+### Synopsis
+
+To load completions:
+
+Bash:
+
+$ source <(coder completion bash)
+
+To load completions for each session, execute once:
+Linux:
+  $ coder completion bash > /etc/bash_completion.d/coder
+MacOS:
+  $ coder completion bash > /usr/local/etc/bash_completion.d/coder
+
+Zsh:
+
+If shell completion is not already enabled in your environment you will need
+to enable it.  You can execute the following once:
+
+$ echo "autoload -U compinit; compinit" >> ~/.zshrc
+
+To load completions for each session, execute once:
+$ coder completion zsh > "${fpath[1]}/_coder"
+
+You will need to start a new shell for this setup to take effect.
+
+Fish:
+
+$ coder completion fish | source
+
+To load completions for each session, execute once:
+$ coder completion fish > ~/.config/fish/completions/coder.fish
+
+
+```
+coder completion [bash|zsh|fish|powershell]
+```
+
+### Examples
+
+```
+coder completion fish > ~/.config/fish/completions/coder.fish
+coder completion zsh > "${fpath[1]}/_coder"
+
+Linux:
+  $ coder completion bash > /etc/bash_completion.d/coder
+MacOS:
+  $ coder completion bash > /usr/local/etc/bash_completion.d/coder
+```
+
+### Options
+
+```
+  -h, --help   help for completion
+```
+
+### SEE ALSO
+
+* [coder](coder.md)	 - coder provides a CLI for working with an existing Coder Enterprise installation

docs/coder_config-ssh.md

@@ -21,4 +21,3 @@ coder config-ssh [flags]
 ### SEE ALSO
 
 * [coder](coder.md)	 - coder provides a CLI for working with an existing Coder Enterprise installation
-

docs/coder_envs.md

@@ -17,4 +17,3 @@ Perform operations on the Coder environments owned by the active user.
 
 * [coder](coder.md)	 - coder provides a CLI for working with an existing Coder Enterprise installation
 * [coder envs ls](coder_envs_ls.md)	 - list all environments owned by the active user
-

docs/coder_envs_ls.md

@@ -26,4 +26,3 @@ coder envs ls [flags]
 ### SEE ALSO
 
 * [coder envs](coder_envs.md)	 - Interact with Coder environments
-

docs/coder_login.md

@@ -19,4 +19,3 @@ coder login [Coder Enterprise URL eg. http://my.coder.domain/] [flags]
 ### SEE ALSO
 
 * [coder](coder.md)	 - coder provides a CLI for working with an existing Coder Enterprise installation
-