docs: Add dependency update plan for breaking changes
This commit is contained in:
35
.github/workflows/ci.yml
vendored
35
.github/workflows/ci.yml
vendored
@@ -12,8 +12,13 @@ jobs:
|
||||
name: Frontend Lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
<<<<<<< HEAD
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-node@v4
|
||||
=======
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v6
|
||||
>>>>>>> Origin/dependabot/github_actions/actions/setup-node-6
|
||||
with:
|
||||
node-version: "18"
|
||||
cache: "npm"
|
||||
@@ -29,8 +34,13 @@ jobs:
|
||||
name: Frontend Type Check
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
<<<<<<< HEAD
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-node@v4
|
||||
=======
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v6
|
||||
>>>>>>> Origin/dependabot/github_actions/actions/setup-node-6
|
||||
with:
|
||||
node-version: "18"
|
||||
cache: "npm"
|
||||
@@ -46,8 +56,13 @@ jobs:
|
||||
name: Frontend Build
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
<<<<<<< HEAD
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-node@v4
|
||||
=======
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v6
|
||||
>>>>>>> Origin/dependabot/github_actions/actions/setup-node-6
|
||||
with:
|
||||
node-version: "18"
|
||||
cache: "npm"
|
||||
@@ -68,8 +83,13 @@ jobs:
|
||||
name: Frontend E2E Tests
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
<<<<<<< HEAD
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-node@v4
|
||||
=======
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v6
|
||||
>>>>>>> Origin/dependabot/github_actions/actions/setup-node-6
|
||||
with:
|
||||
node-version: "18"
|
||||
cache: "npm"
|
||||
@@ -95,8 +115,13 @@ jobs:
|
||||
name: Orchestrator Build
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
<<<<<<< HEAD
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-node@v4
|
||||
=======
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v6
|
||||
>>>>>>> Origin/dependabot/github_actions/actions/setup-node-6
|
||||
with:
|
||||
node-version: "18"
|
||||
cache: "npm"
|
||||
@@ -113,8 +138,13 @@ jobs:
|
||||
name: Contracts Compile
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
<<<<<<< HEAD
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-node@v4
|
||||
=======
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v6
|
||||
>>>>>>> Origin/dependabot/github_actions/actions/setup-node-6
|
||||
with:
|
||||
node-version: "18"
|
||||
cache: "npm"
|
||||
@@ -130,8 +160,13 @@ jobs:
|
||||
name: Contracts Test
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
<<<<<<< HEAD
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-node@v4
|
||||
=======
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v6
|
||||
>>>>>>> Origin/dependabot/github_actions/actions/setup-node-6
|
||||
with:
|
||||
node-version: "18"
|
||||
cache: "npm"
|
||||
|
||||
2
.github/workflows/release.yml
vendored
2
.github/workflows/release.yml
vendored
@@ -13,7 +13,7 @@ jobs:
|
||||
- uses: actions/checkout@v5
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: "18"
|
||||
|
||||
|
||||
128
docs/DEPENDENCY_UPDATE_PLAN.md
Normal file
128
docs/DEPENDENCY_UPDATE_PLAN.md
Normal file
@@ -0,0 +1,128 @@
|
||||
# Dependency Update Plan for Breaking Changes
|
||||
|
||||
## ⚠️ Breaking Changes Requiring Testing
|
||||
|
||||
The following dependency updates have breaking changes and require careful testing before merging:
|
||||
|
||||
### 1. Express.js 5.1.0 (Major Update)
|
||||
**Current**: 4.21.2
|
||||
**Target**: 5.1.0
|
||||
**Status**: ⚠️ **Requires Testing**
|
||||
|
||||
**Breaking Changes**:
|
||||
- Middleware signature changes
|
||||
- Error handling updates
|
||||
- Request/Response API changes
|
||||
|
||||
**Testing Required**:
|
||||
- [ ] All API endpoints work correctly
|
||||
- [ ] Middleware functions are compatible
|
||||
- [ ] Error handling works as expected
|
||||
- [ ] SSE endpoints function properly
|
||||
|
||||
**Action Plan**:
|
||||
1. Create test branch: `git checkout -b test-express-5`
|
||||
2. Merge Dependabot branch
|
||||
3. Run tests: `cd orchestrator && npm test`
|
||||
4. Test API endpoints manually
|
||||
5. Fix any breaking changes
|
||||
6. Merge to main if all tests pass
|
||||
|
||||
---
|
||||
|
||||
### 2. Hardhat 3.0.11 (Major Update)
|
||||
**Current**: 2.26.5
|
||||
**Target**: 3.0.11
|
||||
**Status**: ⚠️ **Requires Testing**
|
||||
|
||||
**Breaking Changes**:
|
||||
- Configuration file format changes
|
||||
- Test API changes
|
||||
- Compilation changes
|
||||
|
||||
**Testing Required**:
|
||||
- [ ] Contracts compile successfully
|
||||
- [ ] Tests run and pass
|
||||
- [ ] Deployment scripts work
|
||||
- [ ] Test utilities are compatible
|
||||
|
||||
**Action Plan**:
|
||||
1. Create test branch: `git checkout -b test-hardhat-3`
|
||||
2. Merge Dependabot branch
|
||||
3. Update `hardhat.config.ts` if needed
|
||||
4. Run: `cd contracts && npm run compile && npm test`
|
||||
5. Fix any breaking changes
|
||||
6. Merge to main if all tests pass
|
||||
|
||||
---
|
||||
|
||||
### 3. Hardhat Toolbox 6.1.0 (Major Update)
|
||||
**Current**: 4.0.0
|
||||
**Target**: 6.1.0
|
||||
**Status**: ⚠️ **Requires Testing**
|
||||
|
||||
**Testing Required**:
|
||||
- [ ] Works with Hardhat 3.x
|
||||
- [ ] All plugins function correctly
|
||||
- [ ] Tests pass
|
||||
|
||||
---
|
||||
|
||||
### 4. Chai 6.2.0 (Major Update)
|
||||
**Current**: 4.5.0
|
||||
**Target**: 6.2.0
|
||||
**Status**: ⚠️ **Requires Testing**
|
||||
|
||||
**Breaking Changes**:
|
||||
- Assertion API changes
|
||||
- Plugin system updates
|
||||
|
||||
**Testing Required**:
|
||||
- [ ] All test assertions work
|
||||
- [ ] Test utilities are compatible
|
||||
- [ ] Update test files if needed
|
||||
|
||||
**Action Plan**:
|
||||
1. Create test branch: `git checkout -b test-chai-6`
|
||||
2. Merge Dependabot branch
|
||||
3. Run: `cd contracts && npm test`
|
||||
4. Update test assertions if needed
|
||||
5. Merge to main if all tests pass
|
||||
|
||||
---
|
||||
|
||||
## ✅ Safe Updates (Already Merged)
|
||||
|
||||
The following updates have been merged as they are safe:
|
||||
|
||||
- ✅ GitHub Actions: checkout v5, setup-node v6, upload-artifact v5, action-gh-release v2
|
||||
- ✅ Type definitions: @types/express 5.0.5, @types/node 24.10.0, @types/chai 5.2.3
|
||||
- ✅ Orchestrator: uuid 13.0.0
|
||||
|
||||
---
|
||||
|
||||
## 📋 Next Steps
|
||||
|
||||
1. **Test Express.js 5.x Update**
|
||||
- Create test branch
|
||||
- Merge and test
|
||||
- Fix breaking changes
|
||||
- Merge to main
|
||||
|
||||
2. **Test Hardhat 3.x Update**
|
||||
- Create test branch
|
||||
- Merge and test
|
||||
- Update configuration
|
||||
- Merge to main
|
||||
|
||||
3. **Test Chai 6.x Update**
|
||||
- Create test branch
|
||||
- Merge and test
|
||||
- Update assertions
|
||||
- Merge to main
|
||||
|
||||
---
|
||||
|
||||
**Status**: Safe updates merged, breaking changes pending testing
|
||||
**Date**: 2025-01-15
|
||||
|
||||
Reference in New Issue
Block a user