Generate some api documentation and put mdox into ci

Author: Tit Petric

Taskfile.yml

@@ -6,6 +6,9 @@ includes:
   deps: .taskfiles/deps.yml
   lint: .taskfiles/lint.yml
   hooks: .taskfiles/hooks.yml
+  docs:
+    taskfile: docs/Taskfile.yml
+    dir: docs/
   opentelemetry:
     taskfile: ci/tests/tracing/Taskfile.yml
     dir: ci/tests/tracing/
@@ -59,11 +62,13 @@ tasks:
         yq -i ".dockers[4].extra_files |= [\"$replacement\"]" ci/goreleaser/goreleaser.yml
       - echo goreleaser release --clean --snapshot -f ci/goreleaser/goreleaser.yml
 
-  codegen:
+  generate:
     deps: [deps]
+    aliases: [codegen, gen]
     desc: "Run code generation steps"
     cmds:
       - go generate ./...
+      - task: docs:codegen
 
   # Used in CI
   lint:
@@ -84,6 +89,7 @@ tasks:
     desc: "Reformat import groups"
     cmds:
       - task: lint:fmt
+      - task: docs:fmt
 
   # This reformats imports with goimports-reviser;
   #

docs/Taskfile.yml

@@ -8,12 +8,36 @@ vars:
     sh: git rev-parse --show-toplevel
 
 tasks:
+  generate:
+    desc: "Generate documentation"
+    aliases: [codegen, gen]
+    cmds:
+      - task: generate:internal
+      - task: generate:plugin
+
+  generate:internal:
+    internal: true
+    desc: "Generate internal API godocs."
+    cmds:
+      - cd '{{.root}}/internal' && go-fsck docs ./... > ../docs/dev/internal.md
+
+  generate:plugin:
+    internal: true
+    desc: "Generate plugin API godocs."
+    cmds:
+      - cd '{{.root}}/ctx'     && go-fsck docs ./... >  ../docs/dev/plugin-apis.md && cd ..
+      - cd '{{.root}}/user'    && go-fsck docs ./... >> ../docs/dev/plugin-apis.md && cd ..
+      - cd '{{.root}}/storage' && go-fsck docs ./... >> ../docs/dev/plugin-apis.md && cd ..
+      - cd '{{.root}}/log'     && go-fsck docs ./... >> ../docs/dev/plugin-apis.md && cd ..
+
   fmt:
     desc: "Run mdox to format markdowns"
     cmds:
-      - mdox fmt --no-soft-wraps $(find -name '*.md')
+      - cd '{{.root}}/docs' && mdox fmt --no-soft-wraps $(find -name '*.md') && cd ..
 
   deps:
-    desc:
+    desc: "Install dependencies"
+    status:
+      - type mdox
     cmds:
       - go install github.com/bwplotka/mdox@latest