CI Refactor Optimize Money Saving

.circleci/config.yml

@@ -1,3 +1,8 @@
+# NX Cloud Configuration:
+# - NX_CLOUD_ACCESS_TOKEN environment variable must be set in CircleCI project settings
+# - NX Cloud provides remote caching for all nx commands (build, build:libs, etc)
+# - Caching happens automatically - no code changes needed
+# - View analytics and cache hits at https://nx.app
 version: 2.1
 parameters:
   run_all_tests:
@@ -36,12 +41,12 @@ jobs:
 
   build:
     docker:
-      - image: cimg/node:20.0.0-browsers
+      - image: cimg/node:20.19.0-browsers
     resource_class: << pipeline.parameters.resource_class >>
     working_directory: ~/remix-project
     steps:
-      - run: sudo apt update && sudo apt install zstd
       - checkout
+      - run: git fetch origin master:master || true
       - restore_cache:
           keys:
             - v1-deps-{{ checksum "yarn.lock" }}
@@ -51,34 +56,18 @@ jobs:
           paths:
             - node_modules
       - run:
-          name: Build
-          command: |
-            if [ "${CIRCLE_BRANCH}" == "master" ]; then
-              NX_BIN_URL=http://127.0.0.1:8080/assets/js/soljson NX_WASM_URL=http://127.0.0.1:8080/assets/js/soljson NX_NPM_URL=http://127.0.0.1:9090/ yarn build:production
-            else
-              NX_BIN_URL=http://127.0.0.1:8080/assets/js/soljson NX_WASM_URL=http://127.0.0.1:8080/assets/js/soljson NX_NPM_URL=http://127.0.0.1:9090/ yarn build
-            fi
+          name: Build for tests
+          command: yarn build
+          environment:
+            NX_VERBOSE_LOGGING: true
+      - run:
+          name: Inject E2E test configuration
+          command: yarn inject-e2e-config
       - run: yarn run build:e2e
-
-      - run: grep -ir "[0-9]+commit" apps/* libs/* --include \*.ts --include \*.tsx --include \*.json > soljson-versions.txt
-      - restore_cache:
-          keys:
-            - soljson-v7-{{ checksum "soljson-versions.txt" }}
-      - run: yarn run downloadsolc_assets_e2e
-      - save_cache:
-          key: soljson-v7-{{ checksum "soljson-versions.txt" }}
-          paths:
-            - dist/apps/remix-ide/assets/js/soljson
-
-      - run: mkdir persist && tar -cf - dist | zstd -1 -o persist/dist.tar.zst
-      - persist_to_workspace:
-          root: .
-          paths:
-            - "persist"
 
   build-plugin:
       docker:
-      - image: cimg/node:20.0.0-browsers
+      - image: cimg/node:20.19.0-browsers
       resource_class: << pipeline.parameters.resource_class >>
       working_directory: ~/remix-project
       parameters:
@@ -94,15 +83,11 @@ jobs:
             key: v1-deps-{{ checksum "yarn.lock" }}
             paths:
               - node_modules
-        - run: yarn nx build << parameters.plugin >> --configuration=production 
-        - run: mkdir persist && zip -0 -r persist/plugin-<< parameters.plugin >>.zip dist
-        - persist_to_workspace:
-            root: .
-            paths:
-              - "persist"  
+        - run: yarn nx build << parameters.plugin >> --configuration=production
+
   lint:
     docker:
-      - image: cimg/node:20.0.0-browsers
+      - image: cimg/node:20.19.0-browsers
     resource_class: << pipeline.parameters.resource_class >>
     working_directory: ~/remix-project
     steps:
@@ -117,13 +102,12 @@ jobs:
           command: node ./apps/remix-ide/ci/lint-targets.js
   remix-libs:
     docker:
-      - image: cimg/node:20.0.0-browsers
+      - image: cimg/node:20.19.0-browsers
     resource_class: << pipeline.parameters.resource_class >>
     working_directory: ~/remix-project
     steps:
       - checkout
-      - attach_workspace:
-          at: .
+      - run: git fetch origin master:master || true
       - restore_cache:
           keys:
             - v1-deps-{{ checksum "yarn.lock" }}
@@ -189,11 +173,33 @@ jobs:
     parallelism: << parameters.parallelism >>
     steps:
       - checkout
-      - attach_workspace:
-          at: .
-      - run: sudo apt update && sudo apt install python3-pip -y zstd
-      - run: zstd -d persist/dist.tar.zst -o persist/dist.tar
-      - run: tar -xf persist/dist.tar
+      - run: git fetch origin master:master || true
+      - restore_cache:
+          keys:
+            - v1-deps-{{ checksum "yarn.lock" }}
+      - run: yarn
+      - save_cache:
+          key: v1-deps-{{ checksum "yarn.lock" }}
+          paths:
+            - node_modules
+      - run:
+          name: Build from NX Cloud cache
+          command: yarn build
+          environment:
+            NX_VERBOSE_LOGGING: true
+      - run:
+          name: Inject E2E test configuration
+          command: yarn inject-e2e-config
+      - run: yarn run build:e2e
+      - run: grep -ir "[0-9]+commit" apps/* libs/* --include \*.ts --include \*.tsx --include \*.json > soljson-versions.txt
+      - restore_cache:
+          keys:
+            - soljson-v7-{{ checksum "soljson-versions.txt" }}
+      - run: yarn run downloadsolc_assets_e2e
+      - save_cache:
+          key: soljson-v7-{{ checksum "soljson-versions.txt" }}
+          paths:
+            - dist/apps/remix-ide/assets/js/soljson
       - run: yarn install --cwd ./apps/remix-ide-e2e --modules-folder ../../node_modules || yarn install --cwd ./apps/remix-ide-e2e --modules-folder ../../node_modules
       - run: mkdir node_modules/hardhat && wget https://unpkg.com/hardhat/console.sol -O node_modules/hardhat/console.sol
       - run: ls -la ./dist/apps/remix-ide/assets/js
@@ -268,12 +274,19 @@ jobs:
     parallelism: << parameters.parallelism >>
     steps:
       - checkout
-      - attach_workspace:
-          at: .
-      - run: sudo apt update && sudo apt install zstd
-      - run: zstd -d persist/dist.tar.zst -o persist/dist.tar
-      - run: tar -xf persist/dist.tar
-      - run: unzip ./persist/plugin-<< parameters.plugin >>.zip
+      - run: git fetch origin master:master || true
+      - restore_cache:
+          keys:
+            - v1-deps-{{ checksum "yarn.lock" }}
+      - run: yarn
+      - save_cache:
+          key: v1-deps-{{ checksum "yarn.lock" }}
+          paths:
+            - node_modules
+      - run:
+          name: Build from NX Cloud cache
+          command: yarn build
+      - run: yarn nx build << parameters.plugin >> --configuration=production
       - run: yarn install --cwd ./apps/remix-ide-e2e --modules-folder ../../node_modules || yarn install --cwd ./apps/remix-ide-e2e --modules-folder ../../node_modules
       - browser-tools/install-browser-tools:
           install-firefox: false
@@ -291,7 +304,7 @@ jobs:
 
   predeploy:
     docker:
-      - image: cimg/node:20.0.0-browsers
+      - image: cimg/node:20.19.0-browsers
     resource_class: << pipeline.parameters.resource_class >>
     working_directory: ~/remix-project
     steps:
@@ -305,15 +318,10 @@ jobs:
           paths:
             - node_modules
       - run: yarn build:production
-      - run: mkdir persist && zip -0 -r persist/predeploy.zip dist
-      - persist_to_workspace:
-          root: .
-          paths:
-            - "persist"
 
   deploy-build:
     docker:
-      - image: cimg/node:20.0.0-browsers
+      - image: cimg/node:20.19.0-browsers
 
     resource_class:
       xlarge
@@ -328,9 +336,15 @@ jobs:
 
     steps:
       - checkout
-      - attach_workspace:
-          at: .
-      - run: unzip ./persist/predeploy.zip
+      - restore_cache:
+          keys:
+            - v1-deps-{{ checksum "yarn.lock" }}
+      - run: yarn
+      - save_cache:
+          key: v1-deps-{{ checksum "yarn.lock" }}
+          paths:
+            - node_modules
+      - run: yarn build:production
       - run: ./apps/remix-ide/ci/deploy_from_travis_remix-<< parameters.script >>.sh
 
 workflows:

.github/workflows/README.md

@@ -0,0 +1,150 @@
+# GitHub Actions Workflows
+
+This directory contains GitHub Actions workflows for the Remix IDE project.
+
+## Workflows
+
+### 1. Build and Cache (`build-and-cache.yml`)
+
+**Purpose:** Automatically builds the project and caches artifacts to NX Cloud on every push.
+
+**Triggers:**
+- Push to `master`, `main`, `develop`, `feat/**`, `fix/**` branches
+- Pull requests to `master`, `main`, `develop` branches
+
+**What it does:**
+- Checks out the code
+- Installs Node.js (version from `.nvmrc`)
+- Installs dependencies with Yarn
+- Builds all projects using NX
+- Uploads build artifacts to NX Cloud cache
+
+**Benefits:**
+- Free caching using GitHub Actions runners (public repos)
+- Pre-warms the NX Cloud cache for CircleCI jobs
+- Fast feedback on build status
+
+---
+
+### 2. E2E Chrome Tests - On Demand (`e2e-chrome-on-demand.yml`)
+
+**Purpose:** Runs end-to-end Chrome browser tests manually when needed.
+
+**Triggers:**
+- Manual trigger via GitHub UI (Actions tab → E2E Tests - Chrome → Run workflow)
+
+**Inputs:**
+- `test_pattern` (optional): Glob pattern to filter tests
+  - Example: `dist/apps/remix-ide-e2e/src/tests/*group1*.test.js`
+  - Leave empty to run all tests
+
+**What it does:**
+1. Builds the project from NX Cloud cache
+2. Injects E2E test configuration (localhost URLs)
+3. Downloads Solidity compiler assets
+4. Installs Chrome and ChromeDriver
+5. Runs Nightwatch E2E tests
+6. Uploads screenshots and reports on failure
+
+**Usage:**
+```bash
+# Via GitHub CLI
+gh workflow run "E2E Tests - Chrome (On Demand)" \
+  -f test_pattern="dist/apps/remix-ide-e2e/src/tests/*group1*.test.js"
+
+# Or use the GitHub web UI:
+# 1. Go to Actions tab
+# 2. Click "E2E Tests - Chrome (On Demand)"
+# 3. Click "Run workflow"
+# 4. Optionally enter a test pattern
+# 5. Click "Run workflow"
+```
+
+---
+
+## Setup Requirements
+
+### GitHub Secrets
+
+Ensure the following secret is set in your GitHub repository settings:
+
+- `NX_CLOUD_ACCESS_TOKEN`: Your NX Cloud access token
+  - Get it from: https://nx.app/orgs/your-org/settings
+  - Or from environment: `echo $NX_CLOUD_ACCESS_TOKEN`
+  - Set it at: Repository Settings → Secrets and variables → Actions → New repository secret
+
+### .nvmrc File
+
+The workflows use the Node.js version specified in `.nvmrc`. Ensure this file exists:
+
+```bash
+cat .nvmrc
+# Should output: v20
+```
+
+---
+
+## Comparison with CircleCI
+
+| Feature | GitHub Actions | CircleCI |
+|---------|---------------|----------|
+| **Cost** | Free (public repos) | Paid minutes |
+| **Speed** | Standard runners | Configurable resources |
+| **Use Case** | Build caching | Full CI/CD pipeline |
+| **Triggers** | Push, PR, manual | Push, scheduled |
+| **E2E Tests** | On-demand only | Automated on every push |
+
+**Strategy:**
+- Use **GitHub Actions** for cheap build caching on every push
+- Use **CircleCI** for comprehensive testing and deployment
+- Both share the same NX Cloud cache for maximum efficiency
+
+---
+
+## Monitoring
+
+### Build Status
+
+Check workflow runs:
+- GitHub UI: Repository → Actions tab
+- Badge: Add to README:
+  ```markdown
+  ![Build](https://github.com/remix-project-org/remix-project/actions/workflows/build-and-cache.yml/badge.svg)
+  ```
+
+### NX Cloud Dashboard
+
+View cache hit rates and performance:
+- https://nx.app/
+
+---
+
+## Troubleshooting
+
+### Workflow fails with "NX_CLOUD_ACCESS_TOKEN not found"
+
+1. Check if the secret is set in repository settings
+2. Verify the secret name matches exactly (case-sensitive)
+3. Ensure you have repository admin access to view secrets
+
+### E2E tests fail with "Cannot find ChromeDriver"
+
+The `install_webdriver` script should handle this. If it fails:
+1. Check if the script exists: `apps/remix-ide-e2e/install-webdriver.sh`
+2. Manually specify ChromeDriver version in the workflow
+
+### Build is not using NX Cloud cache
+
+1. Verify `NX_CLOUD_ACCESS_TOKEN` is set correctly
+2. Check NX Cloud dashboard for your organization
+3. Ensure `nx.json` has the correct runner configuration
+
+---
+
+## Future Improvements
+
+- [ ] Add workflow for running specific test groups (group1, group2, etc.)
+- [ ] Matrix build for multiple Node.js versions
+- [ ] Automatic retry on flaky tests
+- [ ] Parallel test execution
+- [ ] Integration with GitHub Checks API for better PR feedback