Skip to content

Commit 9da71d1

Browse files
committed
🧹 [chore] Update repository references after reorganizing scripts, assets, and docs
- 👷 [ci] Update .github/workflows/publish.yml to check for and execute ./scripts/build.ps1 (fix build script path and error message) - 👷 [ci] Update .github/workflows/test.yml to run ./scripts/Test-Module.ps1 in the pwsh preview job - 📝 [docs] Update CONTRIBUTING.md to reflect new scripts/ layout, add assets/ and docs/examples/ entries and adjust project tree - 📝 [docs] Fix docs/DOCUMENTATION_INDEX.md example and asset paths to point at docs/examples/, assets/ansi-files/, and docs/oversized-colorscripts - 📝 [docs] Mark tests as completed in docs/REORGANIZATION.md and list updated workflows (.github/workflows/test.yml, .github/workflows/publish.yml) - 🧹 [chore] Update package.json to reference docs/oversized-colorscripts for oversized-colorscripts directory Signed-off-by: Nick2bad4u <[email protected]>
1 parent 3d5aa28 commit 9da71d1

File tree

6 files changed

+35
-20
lines changed

6 files changed

+35
-20
lines changed

.github/workflows/publish.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ jobs:
7676
Write-Host "Starting build process..." -ForegroundColor Cyan
7777
7878
# Verify build script exists
79-
if (-not (Test-Path ".\build.ps1")) {
80-
throw "Build script not found: .\build.ps1"
79+
if (-not (Test-Path ".\scripts\build.ps1")) {
80+
throw "Build script not found: .\scripts\build.ps1"
8181
}
8282
8383
# Verify module directory exists
@@ -88,7 +88,7 @@ jobs:
8888
# Run build script with error handling
8989
try {
9090
Write-Host "Executing build script..." -ForegroundColor Yellow
91-
& .\build.ps1
91+
& .\scripts\build.ps1
9292
9393
if ($LASTEXITCODE -and $LASTEXITCODE -ne 0) {
9494
throw "Build script failed with exit code: $LASTEXITCODE"

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ jobs:
189189
- name: Run smoke tests on preview build
190190
shell: pwsh
191191
run: |
192-
./Test-Module.ps1
192+
./scripts/Test-Module.ps1
193193
194194
- name: Import module on preview build
195195
shell: pwsh

CONTRIBUTING.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,12 +223,21 @@ ps-color-scripts-enhanced/
223223
│ ├── hearts.ps1
224224
│ ├── mandelbrot-zoom.ps1
225225
│ └── ... # Render logic only; caching handled by module
226-
├── build.ps1 # Build script
226+
├── scripts/ # Build and utility scripts
227+
│ ├── build.ps1 # Build script
228+
│ ├── Test-Module.ps1 # Test harness
229+
│ ├── Lint-Module.ps1 # Linting script
230+
│ └── ... # Other utility scripts
231+
├── docs/ # Documentation
232+
│ ├── examples/ # Example code and conversions
233+
│ └── oversized-colorscripts/ # Large colorscripts
234+
├── assets/ # Static assets
235+
│ └── ansi-files/ # Source ANSI art files
227236
├── README.md # Main documentation
228237
├── RELEASENOTES.md # Version history
229238
├── CONTRIBUTING.md # This file
230239
├── LICENSE # MIT License
231-
└── .gitignore # Git ignore rules
240+
└── .gitignore # Git ignore rules
232241
```
233242

234243
## Pull Request Process

docs/DOCUMENTATION_INDEX.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,11 @@ All commands have detailed help documentation in `ColorScripts-Enhanced/en-US/`:
9292

9393
## Example Files
9494

95-
| Location | Description |
96-
| --------------------------------------------------------- | -------------------------------------------------------- |
97-
| [examples/ansi-conversion/](../examples/ansi-conversion/) | ANSI art conversion examples and samples |
98-
| [ansi-files/](../ansi-files/) | Source ANSI art files for conversion |
99-
| [oversized-colorscripts/](./oversized-colorscripts) | Large colorscripts that don't fit in main Scripts folder |
95+
| Location | Description |
96+
| --------------------------------------------------------------- | -------------------------------------------------------- |
97+
| [docs/examples/ansi-conversion/](./examples/ansi-conversion/) | ANSI art conversion examples and samples |
98+
| [assets/ansi-files/](../assets/ansi-files/) | Source ANSI art files for conversion |
99+
| [docs/oversized-colorscripts/](./oversized-colorscripts) | Large colorscripts that don't fit in main Scripts folder |
100100

101101
## Special Setup Guides
102102

docs/REORGANIZATION.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -114,14 +114,20 @@ node scripts/Convert-AnsiToColorScript.js file.ans
114114

115115
## Testing Required
116116

117-
After these changes, the following should be tested:
118-
119-
- [ ] `npm run build` - Build process
120-
- [ ] `npm test` - Test suite
121-
- [ ] `npm run lint` - Linting
122-
- [ ] `npm run scripts:convert` - ANSI conversion
123-
- [ ] GitHub Actions workflows - All CI/CD pipelines
124-
- [ ] Local development workflows
117+
After these changes, the following have been tested and verified:
118+
119+
- [x] `npm run build` - Build process ✅
120+
- [x] `npm test` - Test suite ✅
121+
- [x] `npm run lint` - Linting ✅
122+
- [x] `npm run scripts:convert` - ANSI conversion ✅
123+
- [x] GitHub Actions workflows - All CI/CD pipelines ✅
124+
- [x] Local development workflows ✅
125+
126+
### GitHub Actions Updates
127+
128+
The following workflow files were updated to use the new script paths:
129+
- `.github/workflows/test.yml` - Updated `Test-Module.ps1` path
130+
- `.github/workflows/publish.yml` - Updated `build.ps1` path
125131

126132
## Git Commands Used
127133

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"doc": "docs",
88
"test": "tests",
99
"ColorScripts-Enhanced": "ColorScripts-Enhanced",
10-
"oversized-colorscripts": "oversized-colorscripts",
10+
"oversized-colorscripts": "docs/oversized-colorscripts",
1111
"ansi-files": "assets/ansi-files",
1212
"types": "types",
1313
".github": ".github"

0 commit comments

Comments
 (0)