Merge pull request #657 from 0xs34n/develop

Release v5

Author: penovicp

.eslintignore

@@ -1,2 +1,3 @@
 node_modules/
 dist/
+www/

.eslintrc

@@ -23,6 +23,7 @@
     "import/prefer-default-export": 0,
     "@typescript-eslint/naming-convention": 0,
     "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
+    "@typescript-eslint/no-use-before-define": ["error", "nofunc"],
     "func-names": 0
   }
 }

.github/pull_request_template.md

@@ -25,7 +25,6 @@
 - [ ] Performed a self-review of the code
 - [ ] Rebased to the last commit of the target branch (or merged it into my branch)
 - [ ] Linked the issues which this PR resolves
-- [ ] Documented the changes
-- [ ] Updated the docs (www)
+- [ ] Documented the changes in code (API docs will be generated automatically)
 - [ ] Updated the tests
 - [ ] All tests are passing

.github/workflows/_release.yml

@@ -1,4 +1,4 @@
-name: Run Release
+name: _ Run Release
 on:
   workflow_call:
     inputs:
@@ -14,12 +14,15 @@ on:
       #   required: true
       NPM_TOKEN:
         required: true
+
 jobs:
   release:
     name: Run release
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref }}
       - uses: actions/setup-node@v3
         with:
           node-version: lts/*

.github/workflows/_test.yml

@@ -1,6 +1,10 @@
-name: Run Tests
+name: _ Run Tests
 on:
   workflow_call:
+    inputs:
+      is-rpc:
+        type: boolean
+        default: false
     secrets:
       TEST_PROVIDER_BASE_URL:
         required: false
@@ -19,7 +23,8 @@ jobs:
     # TODO - periodically check if conditional services are supported; https://github.com/actions/runner/issues/822
     services:
       devnet:
-        image: shardlabs/starknet-devnet:0.4.4-seed0
+        # image: ${{ inputs.is-rpc && 'shardlabs/starknet-devnet:0.5.3-seed0' || 'shardlabs/starknet-devnet:0.5.2-seed0' }}
+        image: shardlabs/starknet-devnet:0.5.4-seed0
         ports:
           - 5050:5050
 

.github/workflows/manual-docs-version-pr.yml

@@ -0,0 +1,44 @@
+name: '[Manual] Documentation Version PR'
+on:
+  workflow_dispatch:
+    inputs:
+      version-override:
+        description: 'Version override'
+        type: string
+
+jobs:
+  build_docs:
+    name: Documentation build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+          cache: 'npm'
+      - name: Setup
+        run: |
+          npm ci --ignore-scripts
+          cd www/
+          npm ci --ignore-scripts
+      - name: Build
+        run: |
+          args=()
+          [[ "${{ inputs.version-override }}" != "" ]] && args+=( '--version-override=${{ inputs.version-override }}' )
+          [[ "${{ inputs.version-override }}" != "" ]] && args+=( '--git-revision-override=v${{ inputs.version-override }}' )
+          npm run docs:build:version "${args[@]}"
+          npm run docs:version "${args[@]}"
+          npm run format
+          git add www/versioned_docs www/versioned_sidebars www/versions.json
+          git checkout .
+      - name: Create pull request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          branch: ci/docs-version
+          committer: CI <[email protected]>
+          author: CI <[email protected]>
+          commit-message: 'docs: generate documentation version'
+          title: 'CI documentation version'
+          body: ''
+          delete-branch: true
+          reviewers: penovicp, ${{ github.triggering_actor }}

.github/workflows/manual-release.yml

@@ -1,4 +1,4 @@
-name: Manual Release
+name: '[Manual] Release'
 on:
   workflow_dispatch:
     inputs:

.github/workflows/manual-tests-devnet.yml

@@ -1,10 +1,11 @@
-name: Manual Devnet Test
+name: '[Manual] Test Devnet'
 on: workflow_dispatch
 
 jobs:
   tests:
     name: Run test on ${{ matrix.name }}
     strategy:
+      fail-fast: false
       matrix:
         name: [sequencer-devnet, rpc-devnet]
         include:
@@ -14,6 +15,8 @@ jobs:
             TEST_RPC_URL: http://127.0.0.1:5050/rpc
 
     uses: ./.github/workflows/_test.yml
+    with:
+      is-rpc: ${{ matrix.TEST_RPC_URL != '' }}
     secrets:
       TEST_PROVIDER_BASE_URL: ${{ matrix.TEST_PROVIDER_BASE_URL }}
       TEST_RPC_URL: ${{ matrix.TEST_RPC_URL }}

.github/workflows/manual-tests-testnet.yml

@@ -1,4 +1,4 @@
-name: Manual Testnet Test
+name: '[Manual] Test Testnet'
 on: workflow_dispatch
 
 jobs:

.github/workflows/pr-push-dev.yml

@@ -1,13 +1,27 @@
-name: PR/Push Development
+name: '[PR|Push] Development'
 on:
   pull_request:
     branches:
       - beta
       - develop
+    paths:
+      - '__mocks__/**'
+      - '__tests__/**'
+      - 'src/**'
+      - 'package*'
+      - 'ts*'
+      - '!www/**'
   push:
     branches:
       - beta
       - develop
+    paths:
+      - '__mocks__/**'
+      - '__tests__/**'
+      - 'src/**'
+      - 'package*'
+      - 'ts*'
+      - '!www/**'
 
 jobs:
   skip_check:
@@ -18,12 +32,15 @@ jobs:
     steps:
       - id: skip_duplicate
         uses: fkirc/skip-duplicate-actions@v5
+        with:
+          cancel_others: 'true'
 
   tests:
     name: Run test on ${{ matrix.name }}
     needs: [skip_check]
     if: needs.skip_check.outputs.should_skip != 'true'
     strategy:
+      fail-fast: false
       matrix:
         name: [sequencer-devnet, rpc-devnet]
         include:
@@ -33,6 +50,8 @@ jobs:
             TEST_RPC_URL: http://127.0.0.1:5050/rpc
 
     uses: ./.github/workflows/_test.yml
+    with:
+      is-rpc: ${{ matrix.TEST_RPC_URL != '' }}
     secrets:
       TEST_PROVIDER_BASE_URL: ${{ matrix.TEST_PROVIDER_BASE_URL }}
       TEST_RPC_URL: ${{ matrix.TEST_RPC_URL }}