Implement publish and check commands

Author: paveldedik

Diff for: Dockerfile

@@ -0,0 +1,22 @@
+FROM node:18-alpine
+
+ENV version=1.2
+
+# Metadata
+LABEL name=techdocs-check version=$version \
+    maintainer="Pavel Dedik <dedikx@gmail.com>"
+
+RUN apk add --no-cache bash py3-pip && \
+    pip install --no-cache mkdocs-techdocs-core==1.* && \
+    pip install --no-cache shyaml && \
+    npm install -g @techdocs/cli
+
+WORKDIR /app
+
+COPY mkdocs-check.sh /usr/local/bin/mkdocs-check
+COPY techdocs-publish.sh /usr/local/bin/techdocs-publish
+COPY entrypoint.sh /usr/local/bin/entrypoint.sh
+
+USER nobody
+
+ENTRYPOINT ["entrypoint.sh"]

Diff for: README.md

@@ -1,2 +1,34 @@
-# actions-backstage
-Github Actions for various tools useful when running Backstage from Spotify
+# actions-techdocs
+
+Github Action for Backstage's techdocs plugin from Spotify.
+
+## Usage
+
+```yaml
+jobs:
+  techdocs:
+    name: Check & Publish
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      # Runs mkdocs check in all directories containing **/mkdocs.yaml file
+      - name: Run mkdocs check
+        uses: TwistoPayments/actions-techdocs@main
+        with:
+          command: check
+
+      # Runs techdocs generate and techdocs publish commands in all directories containgin
+      # **/mkdocs.yaml file. Currently only S3 publisher is supported.
+      - name: Run techdocs publish
+        uses: TwistoPayments/actions-techdocs@main
+        with:
+          command: publish
+        env:
+          TECHDOCS_PUBLISHER_TYPE: awsS3
+          TECHDOCS_S3_BUCKET_NAME: ${{ secrets.TECHDOCS_S3_BUCKET_NAME }}
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          AWS_REGION: ${{ secrets.AWS_REGION }}
+```

Diff for: action.yml

@@ -0,0 +1,13 @@
+name: 'backstage-techdocs'
+description: 'Run command for technical documentation generation'
+author: 'TwistoPayments Platform team'
+inputs:
+  command:
+    description: Command to run, currently only `check` and `publish`
+    required: true
+
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  args:
+    - ${{ inputs.command }}

Diff for: entrypoint.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+if [ "$1" = "check" ]; then
+  mkdocs-check
+elif [ "$1" = "publish" ]; then
+  techdocs-publish
+else
+  echo "Unknown command."
+fi

Diff for: mkdocs-check.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+working_dir="$PWD"
+
+for mkdocs in $(find . -name mkdocs.yaml 2>/dev/null); do
+  docs_dir=$(dirname $mkdocs)
+
+  echo "info: Running command 'mkdocs build $docs_dir' ..."
+
+  if [ $docs_dir = "." ]; then
+    build_dir="/tmp/root"
+  else
+    build_dir="/tmp/$docs_dir"
+  fi
+
+  cd $docs_dir
+
+  output=$(mkdocs build -d $build_dir 2>&1)
+  errors=$(echo "$output" | grep ERROR)
+
+  if [ -z "$errors" ]; then
+    warnings=$(echo "$output" | grep WARNING)
+
+    if [ -z "$warnings" ]; then
+        echo "info: Build suceeded"
+    else
+        echo "error: Build failed returning the following WARNINGs:"
+        echo ""
+        echo "$warnings"
+        exit 1
+    fi
+
+  else
+    echo "error: Build failed returning the following ERRORs:"
+    echo ""
+    echo "$errors"
+    exit 1
+  fi
+
+  echo ""
+  cd $working_dir
+
+done

Diff for: techdocs-publish.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+working_dir="$PWD"
+
+for mkdocs in $(find . -name mkdocs.yaml 2>/dev/null); do
+  docs_dir=$(dirname $mkdocs)
+
+  echo "info: Found mkdocs.yaml in $docs_dir ..."
+
+  if [ $docs_dir = "." ]; then
+    build_dir="/tmp/root"
+  else
+    build_dir="/tmp/$docs_dir"
+  fi
+
+  cd $docs_dir
+
+  if [[ ! -f 'catalog-info.yaml' ]]; then
+    echo "warning: $build_dir/catalog-info.yaml not found"
+    continue
+  fi
+
+  catalog_info=$(cat catalog-info.yaml)
+
+  kind=$(echo "$catalog_info" | shyaml get-value kind)
+  name=$(echo "$catalog_info" | shyaml get-value metadata.name)
+  namespace=$(echo "$catalog_info" | shyaml get-value metadata.namespace default)
+  entity_name="$namespace/$kind/$name"
+
+  echo "info: Docs for entity $entity_name generating ..."
+  techdocs-cli generate --output-dir $build_dir --no-docker --verbose
+
+  echo "info: Docs for entity $entity_name publishing ..."
+  techdocs-cli publish --publisher-type $TECHDOCS_PUBLISHER_TYPE --storage-name $TECHDOCS_S3_BUCKET_NAME --directory $build_dir --entity $entity_name
+
+  echo "info: Docs for entity $entity_name published"
+  echo ""
+
+  cd $working_dir
+
+done