ci: update api automatisation (#81)

Author: AuHau

.github/workflows/check.yaml

@@ -12,33 +12,45 @@ jobs:
   check:
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        node-version: [14.x]
-
     steps:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0
-      - name: Use Node.js ${{ matrix.node-version }}
+          submodules: true
+
+      - name: Use Node.js 16
         uses: actions/setup-node@v1
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: '16'
 
-      ## Try getting the node modules from cache, if failed npm ci
+      # Cache for the node_modules of Bee JS Docs
       - uses: actions/cache@v2
-        id: cache-npm
+        id: cache-docs-npm
         with:
           path: node_modules
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          key: ${{ runner.os }}-docs-${{ hashFiles('./package-lock.json') }}
           restore-keys: |
-            ${{ runner.OS }}-node-${{ env.cache-name }}-
-            ${{ runner.OS }}-node-
-            ${{ runner.OS }}-
-      - name: Install npm deps
-        if: steps.cache-npm.outputs.cache-hit != 'true'
+            ${{ runner.OS }}-docs-${{ env.cache-name }}-
+            ${{ runner.OS }}-docs-
+
+      - name: Install npm deps for Bee JS Docs
+        if: steps.cache-docs-npm.outputs.cache-hit != 'true'
         run: npm ci
 
+      # Cache for the node_modules of Bee JS
+      - uses: actions/cache@v2
+        id: cache-bee-js-npm
+        with:
+          path: bee-js/node_modules
+          key: ${{ runner.os }}-bee-js-${{ hashFiles('./bee-js/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.OS }}-bee-js-${{ env.cache-name }}-
+            ${{ runner.OS }}-bee-js-
+
+      - name: Install npm deps for Bee-js
+        if: steps.cache-bee-js-npm.outputs.cache-hit != 'true'
+        run: cd bee-js && npm ci && cd ..
+
       - name: Commit linting
         uses: wagoid/commitlint-github-action@v2
 

.github/workflows/gh-pages.yaml

@@ -13,16 +13,43 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         with:
-          fetch-depth: 0
+          submodules: true
 
       - uses: actions/setup-node@v1
         with:
-          node-version: '14'
+          node-version: '16'
+
+      # Cache for the node_modules of Bee JS Docs
+      - uses: actions/cache@v2
+        id: cache-docs-npm
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-docs-${{ hashFiles('./package-lock.json') }}
+          restore-keys: |
+            ${{ runner.OS }}-docs-${{ env.cache-name }}-
+            ${{ runner.OS }}-docs-
+
+      - name: Install npm deps for Bee JS Docs
+        if: steps.cache-docs-npm.outputs.cache-hit != 'true'
+        run: npm ci
+
+      # Cache for the node_modules of Bee JS
+      - uses: actions/cache@v2
+        id: cache-bee-js-npm
+        with:
+          path: bee-js/node_modules
+          key: ${{ runner.os }}-bee-js-${{ hashFiles('./bee-js/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.OS }}-bee-js-${{ env.cache-name }}-
+            ${{ runner.OS }}-bee-js-
+
+      - name: Install npm deps for Bee-js
+        if: steps.cache-bee-js-npm.outputs.cache-hit != 'true'
+        run: cd bee-js && npm ci && cd ..
 
       - name: Build for gh-pages
         run: |
-          npm ci
-          npm run-script build
+          npm run build
           echo "bee-js.ethswarm.org" > ./build/CNAME
           rm ./build/.nojekyll
 

.github/workflows/update-api-docs.yaml

@@ -0,0 +1,34 @@
+name: Update API docs
+
+on:
+  workflow_dispatch:
+  repository_dispatch:
+    types: [trigger-api-docs-pr]
+
+
+jobs:
+  create-api-docs-pr:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      - name: Use Node.js 16
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16.x
+
+      - name: Update Bee-js
+        run: git submodule update --remote --merge
+
+      - name: Create PR
+        uses: gr2m/create-or-update-pull-request-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.REPO_GHA_PAT }}
+        with:
+          title: "feat: new bee-js api docs"
+          body: "Updated Bee-js API references"
+          branch: "feat/new-bee-js-api-docs"
+          commit-message: "feat: new bee-js api docs"
+          author: "bee-worker <[email protected]>"

.gitignore

@@ -4,5 +4,9 @@ node_modules
 build
 public
 resources
+
 # Local Netlify folder
-.netlify
+.netlify
+
+# Generated Bee API docs
+docs/api

README.md

@@ -34,7 +34,6 @@ Don't forget to find and replace the version number for the whole of the docs fo
 
 ## How to generate / include the API reference html
 
-1. Preparation phase - pull bee-js submodule and update it to the necessary commit
 ```sh
 # Initialise the bee-js submodule
 git submodule update --init --recursive
@@ -46,34 +45,10 @@ git submodule update --remote --merge
 cd bee-js
 npm ci
 cd ..
-```
-
-2. Generating the docs - in the `docusaurus.config.js` and uncomment the line 9 with `'docusaurus-plugin-typedoc'` in the plugins array.
-
-Build the api docs now with `npm run build`. This will probably throw some syntax errors like:
 
+# Generate new API
+npm run build
 ```
-./docs/api/functions/utils.bytes.isbytes.md
-SyntaxError: ./bee-js-docs/docs/api/functions/utils.bytes.isbytes.md: Expected corresponding JSX closing tag for <T> (11:39)
-
-   9 | <p><a parentName="p" {...{"href":"/docs/api/modules/utils"}}>{`Utils`}</a>{`.`}<a parentName="p" {...{"href":"/docs/api/modules/utils.bytes"}}>{`Bytes`}</a>{`.isBytes`}</p>
-  10 | <p>{`▸ `}<strong parentName="p">{`isBytes`}</strong>{`<Length`}{`>`}{`(`}<inlineCode parentName="p">{`length`}</inlineCode>{`: Length, `}<inlineCode parentName="p">{`b`}</inlineCode>{`: Uint8Array): b is Bytes<Length`}{`>`}</p>
-> 11 | <p>{`Type guard for Bytes`}<T>{` type`}</p>
-     |                                        ^
-  12 | <h4 {...{"id":"type-parameters"}}>{`Type parameters:`}</h4>
-  13 | <table>
-  14 | <thead parentName="table">
- @ ./.docusaurus/registry.js 1:11691-11761 1:11547-11638
- @ ./node_modules/@docusaurus/core/lib/client/exports/ComponentCreator.js
- @ ./.docusaurus/routes.js
- @ ./node_modules/@docusaurus/core/lib/client/clientEntry.js
- @ multi ./node_modules/@docusaurus/core/lib/client/clientEntry.js
-Client bundle compiled with errors therefore further build is impossible.
-```
-
-3. Fix the issues - run the `escape-chars.bash` script
-   
-4. In the `docusaurus.config.js` and comment the line 9 with `'docusaurus-plugin-typedoc'` in the plugins array so that the building no longer runs typedoc on `bee-js`. Test the page with `npm run start` or `npm run build` and create PR with this updated API reference.
 
 ## Maintainers