Use Typedoc for Wasm API docs

.github/actions/publish/publish-wasm/action.yml

@@ -24,7 +24,7 @@ runs:
         registry-url: 'https://registry.npmjs.org'
 
     - name: Download bindings/wasm artifacts
-      uses: actions/download-artifact@v2
+      uses: actions/download-artifact@v4
       with:
         name: ${{ inputs.input-artifact-name }}
         path: bindings/wasm

.github/workflows/build-and-test.yml

@@ -170,7 +170,7 @@ jobs:
     needs: check-for-run-condition
     if: ${{ needs.check-for-run-condition.outputs.should-run == 'true' }}
     # owner/repository of workflow has to be static, see https://github.community/t/env-variables-in-uses/17466
-    uses: iotaledger/identity.rs/.github/workflows/shared-build-wasm.yml@main
+    uses: iotaledger/identity.rs/.github/workflows/shared-build-wasm.yml@typedoc
     with:
       output-artifact-name: identity-wasm-bindings-build
 
@@ -198,7 +198,7 @@ jobs:
         working-directory: bindings/wasm
 
       - name: Download bindings/wasm artifacts
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
           name: identity-wasm-bindings-build
           path: bindings/wasm
@@ -238,7 +238,7 @@ jobs:
         working-directory: bindings/wasm
 
       - name: Download bindings/wasm artifacts
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
           name: identity-wasm-bindings-build
           path: bindings/wasm
@@ -286,7 +286,7 @@ jobs:
         working-directory: bindings/wasm
 
       - name: Download bindings/wasm artifacts
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
           name: identity-wasm-bindings-build
           path: bindings/wasm

.github/workflows/shared-build-wasm.yml

@@ -82,12 +82,13 @@ jobs:
           os: ${{matrix.os}}
 
       - name: Upload artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ inputs.output-artifact-name }}
           path: |
             bindings/wasm/node
             bindings/wasm/web
             bindings/wasm/examples/dist
+            bindings/wasm/docs
           if-no-files-found: error
           retention-days: 1

.github/workflows/upload-docs.yml

@@ -0,0 +1,51 @@
+name: Build and upload API docs
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to publish docs under (e.g. `v1.2.3-dev.1`)'
+        required: true
+
+permissions:
+  actions: 'write'
+
+jobs:
+  build-wasm: 
+    # owner/repository of workflow has to be static, see https://github.community/t/env-variables-in-uses/17466
+    uses: iotaledger/identity.rs/.github/workflows/shared-build-wasm.yml@typedoc
+    with:
+      run-unit-tests: false
+      ref: ${{ inputs.ref }}
+      output-artifact-name: identity-docs
+
+  upload-docs:
+    runs-on: ubuntu-latest
+    needs: build-wasm
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: identity-docs
+      - name: Get release version
+        id: get_release_version
+        run: |
+          if [ "${{ github.event_name }}" = "release" ]; then
+            INPUT_VERSION="${{ github.ref }}"
+          else
+            INPUT_VERSION="${{ github.event.inputs.version }}"
+          fi
+          VERSION=$(echo $INPUT_VERSION | sed -e 's/.*v\([0-9]*\.[0-9]*\).*/\1/')
+          echo VERSION=$VERSION >> $GITHUB_OUTPUT
+      - name: Compress generated docs
+        run: |
+          tar czvf wasm.tar.gz docs/*
+
+      - name: Upload docs to AWS S3
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID_IOTA_WIKI }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY_IOTA_WIKI }}
+          AWS_DEFAULT_REGION: "eu-central-1"
+        run: |
+          aws s3 cp wasm.tar.gz s3://files.iota.org/iota-wiki/iota-identity/${{ steps.get_release_version.outputs.VERSION }}/ --acl public-read

.github/workflows/wasm-automatic-release-and-publish.yml

@@ -26,7 +26,7 @@ jobs:
     needs: call-create-release-workflow
     if: ${{ needs.call-create-release-workflow.outputs.is-release }}
     # owner/repository of workflow has to be static, see https://github.community/t/env-variables-in-uses/17466
-    uses: iotaledger/identity.rs/.github/workflows/shared-build-wasm.yml@main
+    uses: iotaledger/identity.rs/.github/workflows/shared-build-wasm.yml@typedoc
     with:
       output-artifact-name: identity-wasm-bindings-build
 

.github/workflows/wasm-publish-to-npm.yml

@@ -19,7 +19,7 @@ jobs:
 
   build-wasm: 
     # owner/repository of workflow has to be static, see https://github.community/t/env-variables-in-uses/17466
-    uses: iotaledger/identity.rs/.github/workflows/shared-build-wasm.yml@main
+    uses: iotaledger/identity.rs/.github/workflows/shared-build-wasm.yml@typedoc
     with:
       ref: ${{ github.event.inputs.branch }}
       output-artifact-name: identity-wasm-bindings-build

.gitignore

@@ -28,3 +28,5 @@ index.html
 *.hodl.*
 
 !/bindings/wasm/static/index.html
+
+docs