GRIN/nym
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix docs ci

Browse Source
This commit is contained in:
fmtabbara
2024-07-10 09:49:08 +01:00
parent 96617469e9
commit b8125d735e
13 changed files with 72 additions and 7359 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/ci-sdk-docs-typescript.yml
+11 -8
View File
@@ -17,18 +17,22 @@ jobs:
- uses: rlespinasse/github-slug-action@v3.x
- uses: actions/setup-node@v3
with:
node-version: 18.17
node-version: 18
- name: Install Rust stable
uses: actions-rs/toolchain@v1
with:
toolchain: stable
- name: Setup yarn
run: npm install -g yarn
- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
run_install: true
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.20'
go-version: "1.20"
- name: Install wasm-pack
run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
@@ -36,15 +40,14 @@ jobs:
- name: Install wasm-opt
uses: ./.github/actions/install-wasm-opt
with:
version: '116'
version: "116"
- name: Build branch WASM packages
run: make sdk-wasm-build
- name: Install
run: yarn
- name: Build
run: yarn docs:prod:build
run: pnpm docs:prod:build
- name: Deploy branch to CI www (docs)
continue-on-error: true
uses: easingthemes/ssh-deploy@main
Makefile
+4 -4
View File
@@ -107,12 +107,12 @@ sdk-wasm-build:
$(MAKE) -C wasm/zknym-lib
#$(MAKE) -C wasm/full-nym-wasm
# run this from npm/yarn to ensure tools are in the path, e.g. yarn build:sdk from root of repo
# run this from npm/pnpm to ensure tools are in the path, e.g. pnpm build:sdk from root of repo
sdk-typescript-build:
npx lerna run --scope @nymproject/sdk build --stream
npx lerna run --scope @nymproject/mix-fetch build --stream
npx lerna run --scope @nymproject/node-tester build --stream
yarn --cwd sdk/typescript/codegen/contract-clients build
pnpm --cwd sdk/typescript/codegen/contract-clients build
# NOTE: These targets are part of the main workspace (but not as wasm32-unknown-unknown)
WASM_CRATES = extension-storage nym-client-wasm nym-node-tester-wasm zknym-lib
@@ -170,10 +170,10 @@ build-nym-mixnode:
generate-typescript:
cd tools/ts-rs-cli && cargo run && cd ../..
yarn types:lint:fix
pnpm types:lint:fix
run-api-tests:
cd nym-api/tests/functional_test && yarn test:qa
cd nym-api/tests/functional_test && pnpm test:qa
# Build debian package, and update PPA
deb-mixnode: build-nym-mixnode
package.json
+2 -2
View File
@@ -20,8 +20,8 @@
"build:ci": "pnpm dlx npm-run-all build:types build:packages build:wasm build:ci:sdk",
"postbuild:ci": "pnpm run dev:off",
"build:ci:sdk": "pnpm run --filter '{@nymproject/sdk,@nymproject/node-tester,@nymproject/contract-clients,@nymproject/sdk-react,@nymproject/mix-fetch,@nymproject/nodejs-client,@nymproject/mix-fetch-node}' --stream build",
"docs:prod:build": "run-s docs:prod:build:ws",
"docs:prod:build:ws": "pnpm run --stream docs:prod:build",
"docs:prod:build": "pnpm docs:prod:build:ws",
"docs:prod:build:ws": "pnpm -r docs:prod:build",
"sdk:build": "./sdk/typescript/scripts/build-prod-sdk.sh",
"sdk:publish": "./sdk/typescript/scripts/publish.sh",
"lint": "pnpm -r run --stream lint",
pnpm-lock.yaml
Generated
+33 -24
View File
@@ -45,10 +45,10 @@ importers:
version: 2.13.1(encoding@0.1.13)
'@cosmos-kit/keplr-extension':
specifier: ^2.12.2
version: 2.12.2(@cosmjs/amino@0.32.3)(@cosmjs/proto-signing@0.32.3)(encoding@0.1.13)
version: 2.12.2(@cosmjs/amino@0.32.4)(@cosmjs/proto-signing@0.32.3)(encoding@0.1.13)
'@cosmos-kit/react':
specifier: ^2.17.2
version: 2.17.2(@cosmjs/amino@0.32.3)(@cosmjs/proto-signing@0.32.3)(@interchain-ui/react@1.23.24(@types/react@18.2.78)(babel-plugin-macros@3.1.0)(react-dom@18.2.0(react@18.2.0))(react@18.2.0))(@types/react-dom@18.2.25)(@types/react@18.2.78)(encoding@0.1.13)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)
version: 2.17.2(@cosmjs/amino@0.32.4)(@cosmjs/proto-signing@0.32.3)(@interchain-ui/react@1.23.24(@types/react@18.2.78)(babel-plugin-macros@3.1.0)(react-dom@18.2.0(react@18.2.0))(react@18.2.0))(@types/react-dom@18.2.25)(@types/react@18.2.78)(encoding@0.1.13)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)
'@mui/base':
specifier: 5.0.0-beta.40
version: 5.0.0-beta.40(@types/react@18.2.78)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)
@@ -175,6 +175,13 @@ importers:
version: 5.4.5
sdk/typescript/codegen/contract-clients:
dependencies:
'@cosmjs/amino':
specifier: ^0.32.4
version: 0.32.4
'@cosmjs/cosmwasm-stargate':
specifier: ^0.29.5
version: 0.29.5
devDependencies:
'@cosmwasm/ts-codegen':
specifier: ^0.35.3
@@ -1133,6 +1140,9 @@ importers:
comlink:
specifier: ^4.3.1
version: 4.4.1
ws:
specifier: ^8.18.0
version: 8.18.0
devDependencies:
'@babel/core':
specifier: ^7.15.0
@@ -1182,6 +1192,9 @@ importers:
'@types/node':
specifier: ^16.7.13
version: 16.18.96
'@types/ws':
specifier: ^8.5.10
version: 8.5.10
'@typescript-eslint/eslint-plugin':
specifier: ^5.13.0
version: 5.62.0(@typescript-eslint/parser@5.62.0(eslint@8.57.0)(typescript@4.9.5))(eslint@8.57.0)(typescript@4.9.5)
@@ -1294,6 +1307,9 @@ importers:
'@types/node':
specifier: ^16.7.13
version: 16.18.96
'@types/ws':
specifier: ^8.5.10
version: 8.5.10
'@typescript-eslint/eslint-plugin':
specifier: ^5.13.0
version: 5.62.0(@typescript-eslint/parser@5.62.0(eslint@8.57.0)(typescript@4.9.5))(eslint@8.57.0)(typescript@4.9.5)
@@ -1748,6 +1764,9 @@ importers:
'@types/node':
specifier: ^16.7.13
version: 16.18.96
'@types/ws':
specifier: ^8.5.10
version: 8.5.10
'@typescript-eslint/eslint-plugin':
specifier: ^5.13.0
version: 5.62.0(@typescript-eslint/parser@5.62.0(eslint@8.57.0)(typescript@4.9.5))(eslint@8.57.0)(typescript@4.9.5)
@@ -3641,9 +3660,6 @@ packages:
'@cosmjs/amino@0.29.5':
resolution: {integrity: sha512-Qo8jpC0BiziTSUqpkNatBcwtKNhCovUnFul9SlT/74JUCdLYaeG5hxr3q1cssQt++l4LvlcpF+OUXL48XjNjLw==}
'@cosmjs/amino@0.32.3':
resolution: {integrity: sha512-G4zXl+dJbqrz1sSJ56H/25l5NJEk/pAPIr8piAHgbXYw88OdAOlpA26PQvk2IbSN/rRgVbvlLTNgX2tzz1dyUA==}
'@cosmjs/amino@0.32.4':
resolution: {integrity: sha512-zKYOt6hPy8obIFtLie/xtygCkH9ZROiQ12UHfKsOkWaZfPQUvVbtgmu6R4Kn1tFLI/SRkw7eqhaogmW/3NYu/Q==}
@@ -18694,13 +18710,6 @@ snapshots:
'@cosmjs/math': 0.29.5
'@cosmjs/utils': 0.29.5
'@cosmjs/amino@0.32.3':
dependencies:
'@cosmjs/crypto': 0.32.3
'@cosmjs/encoding': 0.32.3
'@cosmjs/math': 0.32.3
'@cosmjs/utils': 0.32.3
'@cosmjs/amino@0.32.4':
dependencies:
'@cosmjs/crypto': 0.32.4
@@ -18910,7 +18919,7 @@ snapshots:
'@cosmjs/proto-signing@0.32.3':
dependencies:
'@cosmjs/amino': 0.32.3
'@cosmjs/amino': 0.32.4
'@cosmjs/crypto': 0.32.3
'@cosmjs/encoding': 0.32.3
'@cosmjs/math': 0.32.3
@@ -19005,7 +19014,7 @@ snapshots:
'@cosmjs/stargate@0.32.3':
dependencies:
'@confio/ics23': 0.6.8
'@cosmjs/amino': 0.32.3
'@cosmjs/amino': 0.32.4
'@cosmjs/encoding': 0.32.3
'@cosmjs/math': 0.32.3
'@cosmjs/proto-signing': 0.32.3
@@ -19132,11 +19141,11 @@ snapshots:
'@chain-registry/client': 1.48.13(encoding@0.1.13)
'@chain-registry/keplr': 1.68.16
'@chain-registry/types': 0.45.13
'@cosmjs/amino': 0.32.3
'@cosmjs/amino': 0.32.4
'@cosmjs/cosmwasm-stargate': 0.32.4
'@cosmjs/proto-signing': 0.32.3
'@cosmjs/stargate': 0.32.3
'@dao-dao/cosmiframe': 0.1.0(@cosmjs/amino@0.32.3)(@cosmjs/proto-signing@0.32.3)
'@dao-dao/cosmiframe': 0.1.0(@cosmjs/amino@0.32.4)(@cosmjs/proto-signing@0.32.3)
'@walletconnect/types': 2.11.0
bowser: 2.11.0
cosmjs-types: 0.9.0
@@ -19164,10 +19173,10 @@ snapshots:
- uWebSockets.js
- utf-8-validate
'@cosmos-kit/keplr-extension@2.12.2(@cosmjs/amino@0.32.3)(@cosmjs/proto-signing@0.32.3)(encoding@0.1.13)':
'@cosmos-kit/keplr-extension@2.12.2(@cosmjs/amino@0.32.4)(@cosmjs/proto-signing@0.32.3)(encoding@0.1.13)':
dependencies:
'@chain-registry/keplr': 1.68.16
'@cosmjs/amino': 0.32.3
'@cosmjs/amino': 0.32.4
'@cosmjs/proto-signing': 0.32.3
'@cosmos-kit/core': 2.13.1(encoding@0.1.13)
'@keplr-wallet/provider-extension': 0.12.107
@@ -19193,11 +19202,11 @@ snapshots:
- uWebSockets.js
- utf-8-validate
'@cosmos-kit/react-lite@2.12.2(@cosmjs/amino@0.32.3)(@cosmjs/proto-signing@0.32.3)(@types/react-dom@18.2.25)(@types/react@18.2.78)(encoding@0.1.13)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)':
'@cosmos-kit/react-lite@2.12.2(@cosmjs/amino@0.32.4)(@cosmjs/proto-signing@0.32.3)(@types/react-dom@18.2.25)(@types/react@18.2.78)(encoding@0.1.13)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)':
dependencies:
'@chain-registry/types': 0.45.13
'@cosmos-kit/core': 2.13.1(encoding@0.1.13)
'@dao-dao/cosmiframe': 0.1.0(@cosmjs/amino@0.32.3)(@cosmjs/proto-signing@0.32.3)
'@dao-dao/cosmiframe': 0.1.0(@cosmjs/amino@0.32.4)(@cosmjs/proto-signing@0.32.3)
'@types/react': 18.2.78
'@types/react-dom': 18.2.25
react: 18.2.0
@@ -19225,11 +19234,11 @@ snapshots:
- uWebSockets.js
- utf-8-validate
'@cosmos-kit/react@2.17.2(@cosmjs/amino@0.32.3)(@cosmjs/proto-signing@0.32.3)(@interchain-ui/react@1.23.24(@types/react@18.2.78)(babel-plugin-macros@3.1.0)(react-dom@18.2.0(react@18.2.0))(react@18.2.0))(@types/react-dom@18.2.25)(@types/react@18.2.78)(encoding@0.1.13)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)':
'@cosmos-kit/react@2.17.2(@cosmjs/amino@0.32.4)(@cosmjs/proto-signing@0.32.3)(@interchain-ui/react@1.23.24(@types/react@18.2.78)(babel-plugin-macros@3.1.0)(react-dom@18.2.0(react@18.2.0))(react@18.2.0))(@types/react-dom@18.2.25)(@types/react@18.2.78)(encoding@0.1.13)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)':
dependencies:
'@chain-registry/types': 0.45.13
'@cosmos-kit/core': 2.13.1(encoding@0.1.13)
'@cosmos-kit/react-lite': 2.12.2(@cosmjs/amino@0.32.3)(@cosmjs/proto-signing@0.32.3)(@types/react-dom@18.2.25)(@types/react@18.2.78)(encoding@0.1.13)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)
'@cosmos-kit/react-lite': 2.12.2(@cosmjs/amino@0.32.4)(@cosmjs/proto-signing@0.32.3)(@types/react-dom@18.2.25)(@types/react@18.2.78)(encoding@0.1.13)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)
'@interchain-ui/react': 1.23.24(@types/react@18.2.78)(babel-plugin-macros@3.1.0)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)
'@react-icons/all-files': 4.1.0(react@18.2.0)
'@types/react': 18.2.78
@@ -19295,9 +19304,9 @@ snapshots:
dependencies:
'@jridgewell/trace-mapping': 0.3.9
'@dao-dao/cosmiframe@0.1.0(@cosmjs/amino@0.32.3)(@cosmjs/proto-signing@0.32.3)':
'@dao-dao/cosmiframe@0.1.0(@cosmjs/amino@0.32.4)(@cosmjs/proto-signing@0.32.3)':
dependencies:
'@cosmjs/amino': 0.32.3
'@cosmjs/amino': 0.32.4
'@cosmjs/proto-signing': 0.32.3
uuid: 9.0.1
sdk/typescript/codegen/contract-clients/package.json
+7 -3
View File
@@ -15,7 +15,7 @@
"docs:generate:prod": "typedoc --basePath ./docs/tsdoc/nymproject/contract-clients/",
"docs:prod:build": "scripts/build-prod-docs-collect.sh",
"docs:serve": "reload -b -d ./docs -p 3000",
"docs:watch": "nodemon --ext ts --watch './src/**/*' --watch './typedoc.json' --exec \"yarn docs:generate\""
"docs:watch": "nodemon --ext ts --watch './src/**/*' --watch './typedoc.json' --exec \"pnpm docs:generate\""
},
"devDependencies": {
"@cosmwasm/ts-codegen": "^0.35.3",
@@ -26,5 +26,9 @@
"typescript": "^4.6.2"
},
"private": false,
"types": "./dist/index.d.ts"
}
"types": "./dist/index.d.ts",
"dependencies": {
"@cosmjs/amino": "^0.32.4",
"@cosmjs/cosmwasm-stargate": "^0.29.5"
}
}
sdk/typescript/codegen/contract-clients/scripts/build-prod-docs-collect.sh
+1 -1
View File
@@ -7,7 +7,7 @@ set -o pipefail
rm -rf ../../../../dist/ts/docs/tsdoc/nymproject/contract-clients || true
# run the build
yarn docs:generate:prod
pnpm docs:generate:prod
# move the output outside of the yarn/npm workspaces
mkdir -p ../../../../dist/ts/docs/tsdoc/nymproject
sdk/typescript/packages/mix-fetch-node/package.json
+3 -2
View File
@@ -19,11 +19,11 @@
"docs:generate:prod": "typedoc --basePath ./docs/tsdoc/nymproject/sdk/",
"docs:prod:build": "scripts/build-prod-docs-collect.sh",
"docs:serve": "reload -b -d ./docs -p 3000",
"docs:watch": "nodemon --ext ts --watch './src/**/*' --watch './typedoc.json' --exec \"yarn docs:generate\"",
"docs:watch": "nodemon --ext ts --watch './src/**/*' --watch './typedoc.json' --exec \"pnpm docs:generate\"",
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"start": "tsc -w",
"start:dev": "nodemon --watch src -e ts,json --exec 'yarn build:dev:esm'",
"start:dev": "nodemon --watch src -e ts,json --exec 'pnpm build:dev:esm'",
"test": "node --experimental-fetch --experimental-vm-modules node_modules/jest/bin/jest.js -c=jest.config.mjs --no-cache",
"tsc": "tsc --noEmit true"
},
@@ -42,6 +42,7 @@
"@rollup/plugin-wasm": "^6.1.1",
"@types/jest": "^27.0.1",
"@types/node": "^16.7.13",
"@types/ws": "^8.5.10",
"@typescript-eslint/eslint-plugin": "^5.13.0",
"@typescript-eslint/parser": "^5.13.0",
"eslint": "^8.10.0",
sdk/typescript/packages/mix-fetch-node/yarn.lock
-4439
View File
File diff suppressed because it is too large Load Diff
sdk/typescript/packages/mix-fetch/package.json
+5 -3
View File
@@ -24,18 +24,19 @@
"docs:generate:prod": "typedoc --basePath ./docs/tsdoc/nymproject/sdk/",
"docs:prod:build": "scripts/build-prod-docs-collect.sh",
"docs:serve": "reload -b -d ./docs -p 3000",
"docs:watch": "nodemon --ext ts --watch './src/**/*' --watch './typedoc.json' --exec \"yarn docs:generate\"",
"docs:watch": "nodemon --ext ts --watch './src/**/*' --watch './typedoc.json' --exec \"pnpm docs:generate\"",
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"prebuild": "node scripts/showDependencyLocation.cjs",
"start": "tsc -w",
"start:dev": "nodemon --watch src -e ts,json --exec 'yarn build:dev:esm'",
"start:dev": "nodemon --watch src -e ts,json --exec 'pnpm build:dev:esm'",
"test": "node --experimental-vm-modules --no-warnings node_modules/jest/bin/jest.js -c=jest.config.mjs --no-cache",
"tsc": "tsc --noEmit true"
},
"dependencies": {
"@nymproject/mix-fetch-wasm": ">=1.2.4-rc.2 || ^1",
"comlink": "^4.3.1"
"comlink": "^4.3.1",
"ws": "^8.18.0"
},
"devDependencies": {
"@babel/core": "^7.15.0",
@@ -54,6 +55,7 @@
"@rollup/plugin-wasm": "^6.1.1",
"@types/jest": "^27.0.1",
"@types/node": "^16.7.13",
"@types/ws": "^8.5.10",
"@typescript-eslint/eslint-plugin": "^5.13.0",
"@typescript-eslint/parser": "^5.13.0",
"eslint": "^8.10.0",
sdk/typescript/packages/node-tester/package.json
+1 -1
View File
@@ -20,7 +20,7 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"start": "tsc -w",
"start:dev": "nodemon --watch src -e ts,json --exec 'yarn build:dev:esm'",
"start:dev": "nodemon --watch src -e ts,json --exec 'pnpm build:dev:esm'",
"test": "node --experimental-vm-modules --no-warnings node_modules/jest/bin/jest.js -c=jest.config.mjs --no-cache",
"tsc": "tsc --noEmit true"
},
sdk/typescript/packages/nodejs-client/package.json
+3 -2
View File
@@ -17,11 +17,11 @@
"docs:generate:prod": "typedoc --basePath ./docs/tsdoc/nymproject/sdk/",
"docs:prod:build": "scripts/build-prod-docs-collect.sh",
"docs:serve": "reload -b -d ./docs -p 3000",
"docs:watch": "nodemon --ext ts --watch './src/**/*' --watch './typedoc.json' --exec \"yarn docs:generate\"",
"docs:watch": "nodemon --ext ts --watch './src/**/*' --watch './typedoc.json' --exec \"pnpm docs:generate\"",
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"start": "tsc -w",
"start:dev": "nodemon --watch src -e ts,json --exec 'yarn build:dev:esm'",
"start:dev": "nodemon --watch src -e ts,json --exec 'pnpm build:dev:esm'",
"tsc": "tsc --noEmit true"
},
"dependencies": {
@@ -40,6 +40,7 @@
"@rollup/plugin-url": "^8.0.1",
"@rollup/plugin-wasm": "^6.1.1",
"@types/node": "^16.7.13",
"@types/ws": "^8.5.10",
"@typescript-eslint/eslint-plugin": "^5.13.0",
"@typescript-eslint/parser": "^5.13.0",
"eslint": "^8.10.0",
sdk/typescript/packages/nodejs-client/yarn.lock
-2868
View File
File diff suppressed because it is too large Load Diff
sdk/typescript/packages/sdk/package.json
+2 -2
View File
@@ -21,12 +21,12 @@
"docs:generate:prod": "typedoc --basePath ./docs/tsdoc/nymproject/sdk/",
"docs:prod:build": "scripts/build-prod-docs-collect.sh",
"docs:serve": "reload -b -d ./docs -p 3000",
"docs:watch": "nodemon --ext ts --watch './src/**/*' --watch './typedoc.json' --exec \"yarn docs:generate\"",
"docs:watch": "nodemon --ext ts --watch './src/**/*' --watch './typedoc.json' --exec \"pnpm docs:generate\"",
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"prebuild": "node scripts/showDependencyLocation.cjs",
"start": "tsc -w",
"start:dev": "nodemon --watch src -e ts,json --exec 'yarn build:dev:esm'",
"start:dev": "nodemon --watch src -e ts,json --exec 'pnpm build:dev:esm'",
"test": "node --experimental-vm-modules --no-warnings node_modules/jest/bin/jest.js -c=jest.config.mjs --no-cache",
"tsc": "tsc --noEmit true"
},