|
| 1 | +# Summary of Changes for @jakub007d Test Release |
| 2 | + |
| 3 | +## Overview |
| 4 | +All changes made to enable test releases under the `@jakub007d` npm scope without conflicts with the original `@data-driven-forms` packages. |
| 5 | + |
| 6 | +## Changes Made |
| 7 | + |
| 8 | +### 1. Package Renaming |
| 9 | +**What**: Renamed all internal packages from `@data-driven-forms/*` to `@jakub007d/*` |
| 10 | + |
| 11 | +**Files Modified**: |
| 12 | +- All 10 package.json files in `packages/*/` |
| 13 | +- All 10 project.json files in `packages/*/` |
| 14 | +- `nx.json` (release.projects array) |
| 15 | +- Root `package.json` (build scripts) |
| 16 | + |
| 17 | +**Exception**: |
| 18 | +- `@data-driven-forms/editor-pro` kept as-is (external dependency in react-renderer-demo) |
| 19 | + |
| 20 | +### 2. Tests Disabled |
| 21 | +**What**: Disabled test execution in all packages for faster CI/CD |
| 22 | + |
| 23 | +**Files Modified**: |
| 24 | +- All `packages/*/project.json` files (9 files) |
| 25 | +- Changed test targets to simple echo commands |
| 26 | + |
| 27 | +**Why**: Simplify the release testing process without running full test suite |
| 28 | + |
| 29 | +### 3. Workflow Updated |
| 30 | +**What**: Modified CI/CD pipeline behavior |
| 31 | + |
| 32 | +**File**: `.github/workflows/main.yml` |
| 33 | + |
| 34 | +**Changes**: |
| 35 | +- ❌ Removed: Test execution step (`npx nx affected --target=test`) |
| 36 | +- ✅ Added: Conditional release logic |
| 37 | + - **Pull Requests**: Runs `nx release --dry-run` |
| 38 | + - **Push to main/master**: Runs `nx release` (actual publish) |
| 39 | +- ✅ Added: NPM registry configuration |
| 40 | +- ✅ Works for forks too! |
| 41 | + |
| 42 | +### 4. Documentation Created |
| 43 | +**Files Created**: |
| 44 | +- `REVERT_INSTRUCTIONS.txt` - Detailed revert instructions |
| 45 | +- `CHANGES_SUMMARY.md` - This file |
| 46 | +- `.github/workflows/main.yml.backup` - Original workflow backup |
| 47 | + |
| 48 | +## How to Use |
| 49 | + |
| 50 | +### For Pull Requests: |
| 51 | +1. Create a PR |
| 52 | +2. CI will run: build → lint → typecheck → release dry-run |
| 53 | +3. Check the dry-run output to see what would be published |
| 54 | + |
| 55 | +### For Releases: |
| 56 | +1. Push/merge to `main` or `master` branch |
| 57 | +2. CI will run: build → lint → typecheck → **actual npm publish** |
| 58 | +3. Packages published to npm under `@jakub007d/*` scope |
| 59 | + |
| 60 | +**Important**: Make sure `NPM_TOKEN` secret is configured in your GitHub repository settings! |
| 61 | + |
| 62 | +## How to Revert |
| 63 | + |
| 64 | +### Quick Revert (Git): |
| 65 | +```bash |
| 66 | +git revert <commit-hash-of-these-changes> |
| 67 | +git push |
| 68 | +``` |
| 69 | + |
| 70 | +### Manual Revert: |
| 71 | +```bash |
| 72 | +# Revert package names |
| 73 | +find packages -name "package.json" -o -name "project.json" | xargs sed -i 's/@jakub007d/@data-driven-forms/g' |
| 74 | +sed -i 's/@jakub007d/@data-driven-forms/g' nx.json |
| 75 | +sed -i 's/@jakub007d/@data-driven-forms/g' package.json |
| 76 | + |
| 77 | +# Restore workflow |
| 78 | +cp .github/workflows/main.yml.backup .github/workflows/main.yml |
| 79 | + |
| 80 | +# Restore tests - requires manual edit of project.json files |
| 81 | +# or restore from git history |
| 82 | +``` |
| 83 | + |
| 84 | +## Testing the Setup |
| 85 | + |
| 86 | +### Test Locally: |
| 87 | +```bash |
| 88 | +# Dry-run to see what would be published |
| 89 | +npx nx release --dry-run --first-release --verbose |
| 90 | +``` |
| 91 | + |
| 92 | +### Test in CI (Pull Request): |
| 93 | +1. Create a PR with any change |
| 94 | +2. Check GitHub Actions output |
| 95 | +3. Should see dry-run release output |
| 96 | + |
| 97 | +### Test Actual Release: |
| 98 | +1. Ensure NPM_TOKEN is configured |
| 99 | +2. Push to main/master |
| 100 | +3. Check GitHub Actions output |
| 101 | +4. Verify packages on npm: https://www.npmjs.com/~jakub007d |
| 102 | + |
| 103 | +## Package List |
| 104 | + |
| 105 | +Packages that will be published under `@jakub007d/*`: |
| 106 | +1. @jakub007d/react-form-renderer |
| 107 | +2. @jakub007d/common |
| 108 | +3. @jakub007d/mui-component-mapper |
| 109 | +4. @jakub007d/ant-component-mapper |
| 110 | +5. @jakub007d/pf4-component-mapper |
| 111 | +6. @jakub007d/blueprint-component-mapper |
| 112 | +7. @jakub007d/carbon-component-mapper |
| 113 | +8. @jakub007d/suir-component-mapper |
| 114 | +9. @jakub007d/parsers |
| 115 | +10. @jakub007d/react-renderer-demo |
| 116 | + |
| 117 | +## Notes |
| 118 | + |
| 119 | +- Source code remains unchanged (only package.json/project.json/workflow modified) |
| 120 | +- No conflicts with original `@data-driven-forms/*` packages on npm |
| 121 | +- Tests are disabled for speed - re-enable before merging to upstream |
| 122 | +- Workflow works for both original repo and forks |
0 commit comments