dcp-worker 3.2.30 → 3.2.31

package/.gitlab-ci.yml

@@ -10,6 +10,7 @@ default:
 
 stages:
   - build
+  - deploy
 
 tidelift:
   stage: build
@@ -30,3 +31,28 @@ tidelift:
     - ./tidelift alignment save --wait
   allow_failure: true
   cache: []
+
+publish_docs:
+  rules:
+    - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
+      changes:
+        paths:
+          - catalog-info.yaml
+          - docs/
+          # Symlinked into `docs/`, but changes are only detected for by the
+          # source file.`
+          - README.md
+  variables:
+    AWS_ACCESS_KEY_ID: $BACKSTAGE_ACCESS_KEY
+    AWS_SECRET_ACCESS_KEY: $BACKSTAGE_ACCESS_SECRET
+    AWS_DEFAULT_REGION: 'us-east-1'
+    AWS_REGION: 'us-east-1'
+    TECHDOCS_S3_BUCKET_NAME: 'backstage.distributive.network'
+    ENTITY_NAMESPACE: 'default'
+  stage: deploy
+  needs: []
+  image: registry.gitlab.com/distributed-compute-protocol/docker/dcp-ci:2023-09-13
+  script:
+    - npm clean-install
+    - python3 -m pip install mkdocs mkdocs-techdocs-core==1.* mkdocs-same-dir
+    - bin/publish-docs.sh

package/bin/publish-docs.sh

@@ -0,0 +1,74 @@
+#! /usr/bin/env bash
+#
+# @file         publish-docs.sh
+# @athor        Brandon Christie <brandon@distributive.network>
+# @date         Aug 2023
+#
+# @description  Publishes the docs for each component
+#               to backstage.
+
+set -euo pipefail
+
+cd "$(dirname "$0")/.."
+
+ROOT_DIR=$PWD
+
+echo "TechDocs Bucket Name: $TECHDOCS_S3_BUCKET_NAME"
+echo "Namespace: $ENTITY_NAMESPACE"
+
+ENTITY_KIND=$(yq ".kind" < catalog-info.yaml)
+echo "Kind: $ENTITY_KIND"
+
+ENTITY_NAME=$(yq ".metadata.name" < catalog-info.yaml)
+echo "Name: $ENTITY_NAME"
+
+TECHDOCS_REF=$(yq ".metadata.annotations.\"backstage.io/techdocs-ref\"" < catalog-info.yaml)
+echo "TechDocs Ref: $TECHDOCS_REF"
+
+# An example of the the techdocs-ref in the YAML file:
+# dir:./docs/dcp
+#
+# The Regex below will isolate the directory path giving the
+# result 'docs/dcp' for the given example.
+if [[ "$TECHDOCS_REF" =~ dir:\.(.*) ]]; then
+  RELATIVE_DOCS_DIR="${BASH_REMATCH[1]%%[[:space:]]*}"
+  DOCS_DIR="$ROOT_DIR/$RELATIVE_DOCS_DIR"
+fi
+
+# The techdocs-cli commands must be called in the directory where the
+# mkdocs.yml file is present.
+cd "$DOCS_DIR"
+
+# MkDocs requires an index.md or README.md file, if one does not exist it will
+# be generated automatically.
+if ! [ -f index.md ] && ! [ -f README.md ]; then
+  if [ -z "$CI" ]; then  
+    AUTHOR="$(git config user.name) <$(git config user.email)>"
+  else  
+    AUTHOR="$CI_COMMIT_AUTHOR"
+  fi  
+
+  echo "README.md or index.md was not found and will be automatically generated."  
+  cat >> index.md <<EOF
+<!--
+@author  $AUTHOR
+@date    $(date)
+@machine $HOSTNAME
+@rev     $(git rev-parse HEAD)
+-->
+> **Warning**: MkDocs requires a top level index.md or README.md (case sensitive)
+This index.md file has been generated automatically to ensure MkDocs works correctly
+EOF
+fi
+
+npx techdocs-cli generate --no-docker --verbose
+
+npx techdocs-cli publish \
+  --publisher-type awsS3 \
+  --storage-name "$TECHDOCS_S3_BUCKET_NAME" \
+  --entity "$ENTITY_NAMESPACE"/"$ENTITY_KIND"/"$ENTITY_NAME" \
+  --directory "$ROOT_DIR"/site
+
+rm -r "$ROOT_DIR"/site
+
+echo "View generated component: https://backstage.overwatch.distributive.network/docs/default/component/$ENTITY_NAME"

package/catalog-info.yaml

@@ -0,0 +1,21 @@
+# @file         catalog-info.yml
+# @author       Brandon Christie <brandon@distributive.network>
+# @date         Mar 2023
+#
+# @description  Lists all of the components and the paths to all
+#               the documentation that will be published to backstage.
+
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: dcp-worker
+  description: Documentation for the dcp-worker.
+  tags:
+    - documentation
+  annotations:
+    gitlab.com/project-id: '18110002'
+    backstage.io/techdocs-ref: dir:./docs
+spec:
+  type: website
+  lifecycle: production
+  owner: core

package/docs/mkdocs.yml

@@ -0,0 +1,16 @@
+# @file         mkdocs.yml
+# @author       Brandon Christie <brandon@distributive.network>
+# @date         Aug 2023
+#
+# @description  Determines how the component of name: 'dcp-worker'
+#               is formatted on backstage.
+
+site_name: dcp-worker
+repo_url: https://gitlab.com/Distributed-Compute-Protocol/dcp-worker
+edit_uri: edit/develop/docs
+docs_dir: .
+nav:
+  - README.md
+plugins:
+  - techdocs-core
+  - same-dir

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dcp-worker",
-  "version": "3.2.30",
+  "version": "3.2.31",
   "description": "JavaScript portion of DCP Workers for Node.js",
   "main": "bin/dcp-worker",
   "keywords": [
@@ -12,7 +12,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@gitlab.com/Distributed-Compute-Protocol/dcp-worker.git"
+    "url": "git@github.com:Distributed-Compute-Labs/dcp-worker.git"
   },
   "license": "MIT",
   "author": "Kings Distributed Systems",
@@ -37,7 +37,7 @@
     "blessed": "^0.1.81",
     "blessed-contrib": "^4.11.0",
     "chalk": "^4.1.0",
-    "dcp-client": "4.3.0-5",
+    "dcp-client": "4.3.1",
     "semver": "^7.3.8",
     "syslog-client": "1.1.1"
   },
@@ -46,6 +46,7 @@
   },
   "devDependencies": {
     "@kingsds/eslint-config": "^1.0.1",
+    "@techdocs/cli": "1.4.6",
     "eslint": ">=8"
   },
   "peerDependencies": {