Improve Github Actions #6100

avkos · 2023-05-16T16:15:46Z

Description

All tests depend on the build. To decrease build time I've moved ESM and Types builds to a separate process
Fix lint test to auto create .secret file if it doesn't not exists
Replace the 14 to 18 Node version.

Please include a summary of the changes and be sure to follow our Contribution Guidelines.

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

github-actions · 2023-05-16T16:27:28Z

Bundle Stats

Hey there, this message comes from a github action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Asset	Old size	New size	Diff	Diff %
Total	643 KB	643 KB	710 bytes	0.11%

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset	Old size	New size	Diff	Diff %
web3.min.js	626 KB	627 KB	710 bytes	0.11%
../lib/commonjs/index.d.ts	8.43 KB	8.43 KB	0	0.00%
../lib/commonjs/accounts.d.ts	3.67 KB	3.67 KB	0	0.00%
../lib/commonjs/types.d.ts	2.37 KB	2.37 KB	0	0.00%
../lib/commonjs/abi.d.ts	1000 bytes	1000 bytes	0	0.00%
../lib/commonjs/web3.d.ts	808 bytes	808 bytes	0	0.00%
../lib/commonjs/eth.exports.d.ts	280 bytes	280 bytes	0	0.00%
../lib/commonjs/providers.exports.d.ts	148 bytes	148 bytes	0	0.00%
../lib/commonjs/version.d.ts	60 bytes	60 bytes	0	0.00%

cloudflare-workers-and-pages · 2023-05-16T16:34:28Z

Deploying with Cloudflare Pages

Latest commit:	`b74138b`
Status:	✅ Deploy successful!
Preview URL:	https://5e57ebd6.web3-js-docs.pages.dev
Branch Preview URL:	https://improve-github-actions.web3-js-docs.pages.dev

View logs

codecov · 2023-05-16T16:46:20Z

Codecov Report

Merging #6100 (b74138b) into 4.x (88628bb) will not change coverage.
The diff coverage is 100.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##              4.x    #6100   +/-   ##
=======================================
  Coverage   87.93%   87.93%           
=======================================
  Files         199      199           
  Lines        7570     7570           
  Branches     2053     2054    +1     
=======================================
  Hits         6657     6657           
  Misses        913      913

Flag	Coverage Δ
UnitTests	`87.93% <100.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
web3	`∅ <ø> (∅)`
web3-core	`∅ <ø> (∅)`
web3-errors	`∅ <ø> (∅)`
web3-eth	`∅ <ø> (∅)`
web3-eth-abi	`∅ <ø> (∅)`
web3-eth-accounts	`∅ <ø> (∅)`
web3-eth-contract	`∅ <ø> (∅)`
web3-eth-ens	`∅ <ø> (∅)`
web3-eth-iban	`∅ <ø> (∅)`
web3-eth-personal	`∅ <ø> (∅)`
web3-net	`∅ <ø> (∅)`
web3-providers-http	`∅ <ø> (∅)`
web3-providers-ipc	`∅ <ø> (∅)`
web3-providers-ws	`∅ <ø> (∅)`
web3-rpc-methods	`∅ <ø> (∅)`
web3-utils	`∅ <ø> (∅)`
web3-validator	`∅ <ø> (∅)`

avkos · 2023-05-18T21:29:43Z

Blackbox tests fixed

Here is a link to the tests: https://github.com/web3/web3.js/actions/runs/5018104015/jobs/8997618185

spacesailor24 · 2023-05-18T23:40:58Z

packages/web3-eth-accounts/src/account.ts

@@ -67,6 +68,8 @@ import type {
 	SignResult,
 } from './types';

+const secp256k1 = ethereumCryptography.secp256k1 ?? ethereumCryptography;
+


What was the reason for needing this?

in case of ESM secp256k1 was undefined

jdevcs · 2023-05-19T11:38:22Z

.github/workflows/build.yml

@@ -14,7 +14,7 @@ jobs:
  build:
    strategy:
      matrix:
-        node: [14, 16]
+        node: [18, 16]
    name: Build Packages


Suggested change

name: Build Packages

name: Build CJS

lets be consistent with other build naming and more visibility in ci ?

jdevcs · 2023-05-19T11:39:02Z

.github/workflows/build.yml

      - run: tar -czf /tmp/web3-${{ matrix.node }}.js.tar.gz --exclude="./.git" ./
      - uses: actions/upload-artifact@v3
        with:
          name: web3-${{ matrix.node }}.js.tar.gz
          path: /tmp/web3-${{ matrix.node }}.js.tar.gz
-
+  build-cjs-types:


Suggested change

build-cjs-types:

build-esm-types:

jdevcs · 2023-05-19T11:42:57Z

.github/workflows/build.yml

-
+  build-cjs-types:
+      name: Build ESM & Types
+      needs: build


there is no need of needs: build so it should be removed? as ESM is not dependent on CJS technical

esm build doesn't work without cjs

https://github.com/web3/web3.js/actions/runs/5027592934/jobs/9017264915?pr=6100

@avkos It should though, our code is written using modules, so the CJS build should be irrelevant. I think when can keep this as is, but should create an issue to investigate further @jdevcs?

jdevcs · 2023-05-19T11:45:26Z

.github/workflows/build.yml

+          matrix:
+              node: [ 18 ]


matrix should only be used when we want to run job for multiple variables, so it should be removed, as Lint is being run for one node version.

jdevcs · 2023-05-19T11:45:38Z

.github/workflows/build.yml


  build-web:
    name: Build Web
    needs: build
    runs-on: ubuntu-latest
+    strategy:
+        matrix:
+            node: [ 18 ]


same here, for matrix

jdevcs · 2023-05-19T11:46:43Z

.github/workflows/e2e_network_tests.yml

 jobs:
  build:
    strategy:
      matrix:
-        node: [14]
+        node: [16]


same here for matrix

jdevcs · 2023-05-19T11:50:55Z

Thanks @avkos for fixing ESM bug, and testing on v18,
I suggested few improvements ( less priority ) as compared to other bugs like ( truffle migration bugs, tx, ..etc ) so we can do it later after full release if its time consuming.

spacesailor24

Assuming we create an issue to track above esm build error, LGTM

init

4784005

avkos requested review from jdevcs, luu-alex, Muhammad-Altabba, nikoulai and spacesailor24 as code owners May 16, 2023 16:15

move build types

29e25de

github-actions bot deployed to web3-js-docs (Preview) May 16, 2023 16:34 View deployment

github-actions bot deployed to web3-js-docs (Preview) May 16, 2023 16:46 View deployment

combine lint and esm build

4988b03

github-actions bot deployed to web3-js-docs (Preview) May 16, 2023 17:11 View deployment

avkos added 2 commits May 16, 2023 13:44

Merge branch '4.x' into improve-github-actions

cf246b9

fix lint tests

417b2ac

github-actions bot deployed to web3-js-docs (Preview) May 16, 2023 18:07 View deployment

avkos added 4 commits May 16, 2023 16:21

separate lint

603f6cf

independ lint

cc9c771

testing lint ptoblem

87b587b

test lint

4ac00dd

github-actions bot deployed to web3-js-docs (Preview) May 16, 2023 20:38 View deployment

github-actions bot deployed to web3-js-docs (Preview) May 16, 2023 20:43 View deployment

github-actions bot deployed to web3-js-docs (Preview) May 16, 2023 20:45 View deployment

avkos added 2 commits May 16, 2023 16:50

fix lint

0fb0d12

Merge branch '4.x' into improve-github-actions

878e79d

github-actions bot deployed to web3-js-docs (Preview) May 16, 2023 20:52 View deployment

move to node 18. fix lint

c21f8e6

github-actions bot deployed to web3-js-docs (Preview) May 16, 2023 21:22 View deployment

16 to 18

febdf69

github-actions bot deployed to web3-js-docs (Preview) May 18, 2023 17:21 View deployment

avkos added 3 commits May 18, 2023 15:08

fix and test

948c907

fix

f1b7fbc

fix data test

72fdc55

remove running on PRs

ee093d7

github-actions bot deployed to web3-js-docs (Preview) May 18, 2023 21:54 View deployment

spacesailor24 reviewed May 18, 2023

View reviewed changes

luu-alex approved these changes May 19, 2023

View reviewed changes

jdevcs reviewed May 19, 2023

View reviewed changes

avkos added 4 commits May 19, 2023 15:16

mode fix to constant only. fix actions config

4ac71c0

fix esm-types build

6e29388

test blackbox

a73c8c8

Merge branch '4.x' into improve-github-actions

c1dabf8

github-actions bot deployed to web3-js-docs (Preview) May 19, 2023 19:32 View deployment

switch off bb tests

b74138b

github-actions bot deployed to web3-js-docs (Preview) May 19, 2023 19:41 View deployment

avkos requested review from spacesailor24 and jdevcs May 19, 2023 20:05

github-actions bot deployed to web3-js-docs (Preview) May 19, 2023 20:07 View deployment

spacesailor24 approved these changes May 19, 2023

View reviewed changes

spacesailor24 merged commit ed5a7f8 into 4.x May 19, 2023

spacesailor24 deleted the improve-github-actions branch May 19, 2023 23:15

djrann13 linked an issue May 20, 2023 that may be closed by this pull request

Add repository #6109

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve Github Actions #6100

Improve Github Actions #6100

avkos commented May 16, 2023 •

edited

Loading

github-actions bot commented May 16, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented May 16, 2023 •

edited

Loading

codecov bot commented May 16, 2023 •

edited

Loading

avkos commented May 18, 2023

spacesailor24 May 18, 2023

jdevcs May 19, 2023

jdevcs May 19, 2023

avkos May 19, 2023

jdevcs May 19, 2023

avkos May 19, 2023

jdevcs May 19, 2023

avkos May 19, 2023 •

edited

Loading

spacesailor24 May 19, 2023

avkos May 19, 2023

jdevcs May 19, 2023

avkos May 19, 2023

jdevcs May 19, 2023

avkos May 19, 2023

jdevcs May 19, 2023

avkos May 19, 2023

jdevcs commented May 19, 2023

spacesailor24 left a comment •

edited

Loading

Improve Github Actions #6100

Improve Github Actions #6100

Conversation

avkos commented May 16, 2023 • edited Loading

Description

Type of change

Checklist:

github-actions bot commented May 16, 2023 • edited Loading

Bundle Stats

cloudflare-workers-and-pages bot commented May 16, 2023 • edited Loading

Deploying with Cloudflare Pages

codecov bot commented May 16, 2023 • edited Loading

Codecov Report

avkos commented May 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

avkos May 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jdevcs commented May 19, 2023

spacesailor24 left a comment • edited Loading

Choose a reason for hiding this comment

avkos commented May 16, 2023 •

edited

Loading

github-actions bot commented May 16, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented May 16, 2023 •

edited

Loading

codecov bot commented May 16, 2023 •

edited

Loading

avkos May 19, 2023 •

edited

Loading

spacesailor24 left a comment •

edited

Loading