feat: add comprehensive update script for n8n dependencies

- Created update-and-publish-prep.sh script that automates entire update process
- Script now runs all 1,182 tests before allowing updates
- Automatically bumps version and updates README badges
- Integrates with npm publish preparation workflow
- Added 'npm run update:all' command for one-step updates
- Updated MEMORY_N8N_UPDATE.md with new comprehensive process

The new workflow ensures:
- All tests pass before version bump
- README badges stay in sync
- Consistent commit messages
- Ready for npm publish after update

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
czlonkowski
2025-07-30 09:53:40 +02:00
parent 0e26a46af9
commit ced38b2f8a
3 changed files with 284 additions and 14 deletions

View File

@@ -1,17 +1,49 @@
# n8n Update Process - Quick Reference
## Quick Steps to Update n8n
## Quick One-Command Update
When there's a new n8n version available, follow these steps:
For a complete update with tests and publish preparation:
```bash
npm run update:all
```
This single command will:
1. ✅ Check for n8n updates and ask for confirmation
2. ✅ Update all n8n dependencies to latest compatible versions
3. ✅ Run all 1,182 tests (933 unit + 249 integration)
4. ✅ Validate critical nodes
5. ✅ Build the project
6. ✅ Bump the version
7. ✅ Update README badges
8. ✅ Prepare everything for npm publish
9. ✅ Create a comprehensive commit
## Manual Steps (if needed)
### Quick Steps to Update n8n
```bash
# 1. Update n8n dependencies automatically
npm run update:n8n
# 2. Validate the update
# 2. Run tests
npm test
# 3. Validate the update
npm run validate
# 3. Commit and push
# 4. Build
npm run build
# 5. Bump version
npm version patch
# 6. Update README badges manually
# - Update version badge
# - Update n8n version badge
# 7. Commit and push
git add -A
git commit -m "chore: update n8n to vX.X.X
@@ -21,6 +53,7 @@ git commit -m "chore: update n8n to vX.X.X
- Updated @n8n/n8n-nodes-langchain from X.X.X to X.X.X
- Rebuilt node database with XXX nodes
- Sanitized XXX workflow templates (if present)
- All 1,182 tests passing (933 unit, 249 integration)
- All validation tests passing
🤖 Generated with [Claude Code](https://claude.ai/code)
@@ -31,8 +64,21 @@ git push origin main
## What the Commands Do
### `npm run update:all`
This comprehensive command:
1. Checks current branch and git status
2. Shows current versions and checks for updates
3. Updates all n8n dependencies to compatible versions
4. **Runs the complete test suite** (NEW!)
5. Validates critical nodes
6. Builds the project
7. Bumps the patch version
8. Updates version badges in README
9. Creates a detailed commit with all changes
10. Provides next steps for GitHub release and npm publish
### `npm run update:n8n`
This single command:
This command:
1. Checks for the latest n8n version
2. Updates n8n and all its required dependencies (n8n-core, n8n-workflow, @n8n/n8n-nodes-langchain)
3. Runs `npm install` to update package-lock.json
@@ -45,13 +91,20 @@ This single command:
- Shows database statistics
- Confirms everything is working correctly
### `npm test`
- Runs all 1,182 tests
- Unit tests: 933 tests across 30 files
- Integration tests: 249 tests across 14 files
- Must pass before publishing!
## Important Notes
1. **Always run on main branch** - Make sure you're on main and it's clean
2. **The update script is smart** - It automatically syncs all n8n dependencies to compatible versions
3. **Database rebuild is automatic** - The update script handles this for you
4. **Template sanitization is automatic** - Any API tokens in workflow templates are replaced with placeholders
5. **Docker image builds automatically** - Pushing to GitHub triggers the workflow
3. **Tests are required** - The publish script now runs tests automatically
4. **Database rebuild is automatic** - The update script handles this for you
5. **Template sanitization is automatic** - Any API tokens in workflow templates are replaced with placeholders
6. **Docker image builds automatically** - Pushing to GitHub triggers the workflow
## GitHub Push Protection
@@ -62,12 +115,18 @@ As of July 2025, GitHub's push protection may block database pushes if they cont
3. If push is still blocked, use the GitHub web interface to review and allow the push
## Time Estimate
- Total time: ~3-5 minutes
- Most time is spent on `npm install` and database rebuild
- The actual commands take seconds to run
- Total time: ~5-7 minutes
- Test suite: ~2.5 minutes
- npm install and database rebuild: ~2-3 minutes
- The rest: seconds
## Troubleshooting
If tests fail:
1. Check the test output for specific failures
2. Run `npm run test:unit` or `npm run test:integration` separately
3. Fix any issues before proceeding with the update
If validation fails:
1. Check the error message - usually it's a node type reference issue
2. The update script handles most compatibility issues automatically
@@ -79,6 +138,23 @@ To see what would be updated without making changes:
npm run update:n8n:check
```
At the end, update version badges in README.md
This shows you the available updates without modifying anything.
This shows you the available updates without modifying anything.
## Publishing to npm
After updating:
```bash
# Prepare for publish (runs tests automatically)
npm run prepare:publish
# Follow the instructions to publish with OTP
cd npm-publish-temp
npm publish --otp=YOUR_OTP_CODE
```
## Creating a GitHub Release
After pushing:
```bash
gh release create vX.X.X --title "vX.X.X" --notes "Updated n8n to vX.X.X"
```