Merge branch 'develop' into patch/nodejs-envvar-cleanup

.github/workflows/bindings-python.yml

@@ -112,6 +112,11 @@ jobs:
           sudo apt-get update
           sudo apt-get install libudev-dev libusb-1.0-0-dev
 
+      - name: Run linter for iota_sdk
+        if: ${{ startsWith(matrix.os, 'ubuntu-latest') }}
+        working-directory: bindings/python
+        run: tox -e lint-sdk
+
       - name: Run linter for examples
         if: ${{ startsWith(matrix.os, 'ubuntu-latest') }}
         working-directory: bindings/python

.github/workflows/cli-publish.yml

@@ -67,8 +67,13 @@ jobs:
           sudo apt-get install libudev-dev libusb-1.0-0-dev
 
       - name: Install gon (macOS)
-        # https://github.com/mitchellh/gon
-        run: brew install mitchellh/gon/gon
+        # Fork of https://github.com/mitchellh/gon
+        # https://github.com/Bearer/gon
+        # Since we're dealing with code signing secrets we want to pin the version of gon
+        run: |
+          wget https://raw.githubusercontent.com/Bearer/homebrew-tap/366bc999e14a8d04e07e24f9387bcbaf89c1bc53/Formula/gon.rb
+          brew install --formula gon.rb
+          rm gon.rb
         if: matrix.os == 'macos-latest'
 
       - name: Install LLVM and Clang (Windows) # required for bindgen to work, see https://github.com/rust-lang/rust-bindgen/issues/1797

.github/workflows/lint.yml

@@ -119,6 +119,30 @@ jobs:
       - name: Run cargo-license-template
         run: cargo ci-license
 
+  check-docs:
+    name: Check Documentation
+    runs-on: ubuntu-latest
+    env:
+      RUSTDOCFLAGS: -D warnings
+
+    steps:
+      - name: Checkout the Source Code
+        uses: actions/checkout@v3
+
+      - name: Set up Rust
+        uses: ./.github/actions/setup-rust
+        with:
+          toolchain: nightly
+          components: rustfmt
+
+      - name: Install Required Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install libudev-dev libusb-1.0-0-dev
+
+      - name: Run cargo-doc
+        run: cargo ci-doc
+
   audit:
     name: Perform Security Audit
     runs-on: ubuntu-latest

.github/workflows/upload-docs.yml

@@ -0,0 +1,80 @@
+name: Build and upload API docs
+
+on:
+  release:
+    types: [published]
+
+env:
+  GH_TOKEN: ${{ github.token }}
+
+permissions:
+  actions: 'write'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Get release language
+        id: get_release_language
+        run: |
+          if [[ ${{ github.ref }} == *"python"* ]]; then
+            echo LANGUAGE="python" >> $GITHUB_OUTPUT
+          fi
+          if [[ ${{ github.ref }} == *"nodejs"* ]]; then
+            echo LANGUAGE="nodejs" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Check if release language is supported
+        if: steps.get_release_language.outputs.LANGUAGE != 'python' && steps.get_release_language.outputs.LANGUAGE != 'nodejs'
+        run: gh run cancel ${{ github.run_id }}
+
+      - name: Set up Rust
+        uses: ./.github/actions/setup-rust
+
+      - name: Set Up Node.js 18 and Yarn Cache
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+
+      - name: Install Required Dependencies (Ubuntu)
+        run: |
+          sudo apt-get update
+          sudo apt-get install libudev-dev libusb-1.0-0-dev
+
+      - name: Get release version
+        id: get_release_version
+        run: |
+          VERSION=$(echo ${{ github.ref }} | sed -e 's/.*v\([0-9]*\.[0-9]*\).*/\1/')
+          echo VERSION=$VERSION >> $GITHUB_OUTPUT
+      
+      - name: Build python docs
+        if: steps.get_release_language.outputs.LANGUAGE == 'python'
+        run: |
+          cd bindings/python
+          pip install -r requirements-dev.txt
+          PYTHONPATH=. pydoc-markdown
+          cd -
+
+      - name: Build nodejs docs
+        if: steps.get_release_language.outputs.LANGUAGE == 'nodejs'
+        run: |
+          cd bindings/nodejs
+          # The SDK still uses yarn classic: https://github.com/iotaledger/iota-sdk/issues/433
+          yarn set version classic
+          yarn
+          yarn create-api-docs --out ../../docs/nodejs
+          cd -
+
+      - name: Compress generated docs
+        run: |
+          tar czvf ${{ steps.get_release_language.outputs.LANGUAGE }}.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 ${{ steps.get_release_language.outputs.LANGUAGE }}.tar.gz s3://files.iota.org/iota-wiki/iota-sdk/${{ steps.get_release_version.outputs.VERSION }}/ --acl public-read

.gitignore

@@ -30,3 +30,6 @@ address.json
 .DS_Store
 book
 .venv*
+
+# Temporary documentation
+docs