Skip to content

Commit 4469b1a

Browse files
(MAINT) Rename build.new.ps1 to build.ps1
This change renames the build script and updates all references to it in configuration, CI automation, and maintainer documentation.
1 parent 19c6084 commit 4469b1a

File tree

6 files changed

+91
-91
lines changed

6 files changed

+91
-91
lines changed

.github/instructions/instructions.md

Lines changed: 60 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The DSC project is built using Rust and PowerShell. The build system automatical
2929

3030
### Automatically Installed by Build Script
3131

32-
The `build.new.ps1` script automatically installs or verifies the following dependencies:
32+
The `build.ps1` script automatically installs or verifies the following dependencies:
3333

3434
- **Clippy**: Rust linting tool (when using `-Clippy` flag)
3535
- **Node.js**: Required for tree-sitter grammar generation
@@ -55,30 +55,30 @@ For a quick build and test on your current platform:
5555

5656
```powershell
5757
# Build the project in debug mode
58-
./build.new.ps1
58+
./build.ps1
5959
6060
# Build with linting (recommended)
61-
./build.new.ps1 -Clippy
61+
./build.ps1 -Clippy
6262
6363
# Build and run all tests
64-
./build.new.ps1 -Clippy -Test
64+
./build.ps1 -Clippy -Test
6565
6666
# Build in release mode (optimized)
67-
./build.new.ps1 -Release
67+
./build.ps1 -Release
6868
```
6969

7070
## Building the Project
7171

72-
The main build script is `build.new.ps1`, which orchestrates the entire build process.
72+
The main build script is `build.ps1`, which orchestrates the entire build process.
7373

7474
### Basic Build
7575

7676
```powershell
7777
# Debug build (default)
78-
./build.new.ps1
78+
./build.ps1
7979
8080
# Release build (optimized, slower compile time)
81-
./build.new.ps1 -Release
81+
./build.ps1 -Release
8282
```
8383

8484
### Build with Linting
@@ -87,10 +87,10 @@ It's recommended to lint before building to catch issues early:
8787

8888
```powershell
8989
# Build with Clippy linting
90-
./build.new.ps1 -Clippy
90+
./build.ps1 -Clippy
9191
9292
# Build release version with linting
93-
./build.new.ps1 -Clippy -Release
93+
./build.ps1 -Clippy -Release
9494
```
9595

9696
### Cross-Platform Builds
@@ -99,46 +99,46 @@ Build for a specific architecture:
9999

100100
```powershell
101101
# Windows on ARM
102-
./build.new.ps1 -Architecture aarch64-pc-windows-msvc
102+
./build.ps1 -Architecture aarch64-pc-windows-msvc
103103
104104
# Windows on x64
105-
./build.new.ps1 -Architecture x86_64-pc-windows-msvc
105+
./build.ps1 -Architecture x86_64-pc-windows-msvc
106106
107107
# macOS on ARM (Apple Silicon)
108-
./build.new.ps1 -Architecture aarch64-apple-darwin
108+
./build.ps1 -Architecture aarch64-apple-darwin
109109
110110
# macOS on x64 (Intel)
111-
./build.new.ps1 -Architecture x86_64-apple-darwin
111+
./build.ps1 -Architecture x86_64-apple-darwin
112112
113113
# Linux on ARM with glibc
114-
./build.new.ps1 -Architecture aarch64-unknown-linux-gnu
114+
./build.ps1 -Architecture aarch64-unknown-linux-gnu
115115
116116
# Linux on x64 with glibc
117-
./build.new.ps1 -Architecture x86_64-unknown-linux-gnu
117+
./build.ps1 -Architecture x86_64-unknown-linux-gnu
118118
119119
# Linux on x64 with musl (static linking)
120-
./build.new.ps1 -Architecture x86_64-unknown-linux-musl
120+
./build.ps1 -Architecture x86_64-unknown-linux-musl
121121
```
122122

123123
### Build Specific Projects
124124

125125
```powershell
126126
# Build only specific projects
127-
./build.new.ps1 -Project dsc,y2j
127+
./build.ps1 -Project dsc,y2j
128128
```
129129

130130
### Clean Build
131131

132132
```powershell
133133
# Clean and rebuild
134-
./build.new.ps1 -Clean
134+
./build.ps1 -Clean
135135
```
136136

137137
### Skip Build (Useful for Testing Only)
138138

139139
```powershell
140140
# Skip building, only run tests
141-
./build.new.ps1 -SkipBuild -Test
141+
./build.ps1 -SkipBuild -Test
142142
```
143143

144144
### Build Artifacts
@@ -158,30 +158,30 @@ The DSC project includes two types of tests:
158158

159159
```powershell
160160
# Build and run all tests
161-
./build.new.ps1 -Test
161+
./build.ps1 -Test
162162
163163
# Run all tests with linting
164-
./build.new.ps1 -Clippy -Test
164+
./build.ps1 -Clippy -Test
165165
```
166166

167167
### Run Only Rust Tests
168168

169169
```powershell
170170
# Build and run Rust tests only
171-
./build.new.ps1 -Test -ExcludePesterTests
171+
./build.ps1 -Test -ExcludePesterTests
172172
173173
# Skip build, run Rust tests only
174-
./build.new.ps1 -SkipBuild -Test -ExcludePesterTests
174+
./build.ps1 -SkipBuild -Test -ExcludePesterTests
175175
```
176176

177177
### Run Only Pester Tests
178178

179179
```powershell
180180
# Build and run Pester tests only
181-
./build.new.ps1 -Test -ExcludeRustTests
181+
./build.ps1 -Test -ExcludeRustTests
182182
183183
# Skip build, run Pester tests only
184-
./build.new.ps1 -SkipBuild -Test -ExcludeRustTests
184+
./build.ps1 -SkipBuild -Test -ExcludeRustTests
185185
```
186186

187187
### Run Specific Pester Test Groups
@@ -190,30 +190,30 @@ Pester tests are organized into groups:
190190

191191
```powershell
192192
# Run tests for DSC CLI
193-
./build.new.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup dsc
193+
./build.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup dsc
194194
195195
# Run tests for adapters
196-
./build.new.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup adapters
196+
./build.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup adapters
197197
198198
# Run tests for extensions
199-
./build.new.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup extensions
199+
./build.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup extensions
200200
201201
# Run tests for resources
202-
./build.new.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup resources
202+
./build.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup resources
203203
204204
# Run tests for grammars
205-
./build.new.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup grammars
205+
./build.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup grammars
206206
207207
# Run multiple test groups
208-
./build.new.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup dsc,resources
208+
./build.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup dsc,resources
209209
```
210210

211211
### Test Documentation
212212

213213
```powershell
214214
# Generate and test Rust documentation
215-
./build.new.ps1 -RustDocs
216-
./build.new.ps1 -SkipBuild -RustDocs -Test -ExcludeRustTests -ExcludePesterTests
215+
./build.ps1 -RustDocs
216+
./build.ps1 -SkipBuild -RustDocs -Test -ExcludeRustTests -ExcludePesterTests
217217
```
218218

219219
## Linting
@@ -224,10 +224,10 @@ Clippy is the recommended linter for Rust code:
224224

225225
```powershell
226226
# Lint and build
227-
./build.new.ps1 -Clippy
227+
./build.ps1 -Clippy
228228
229229
# Lint without building (faster)
230-
./build.new.ps1 -SkipBuild -Clippy
230+
./build.ps1 -SkipBuild -Clippy
231231
```
232232

233233
Clippy checks are enforced in CI and must pass before merging pull requests.
@@ -237,7 +237,7 @@ Clippy checks are enforced in CI and must pass before merging pull requests.
237237
Run cargo audit to check for security vulnerabilities:
238238

239239
```powershell
240-
./build.new.ps1 -Audit
240+
./build.ps1 -Audit
241241
```
242242

243243
## Creating Packages
@@ -254,33 +254,33 @@ You must specify a specific architecture (not `current`) when packaging.
254254

255255
```powershell
256256
# Create MSIX package (Windows only)
257-
./build.new.ps1 -PackageType msix -Architecture x86_64-pc-windows-msvc -Release
257+
./build.ps1 -PackageType msix -Architecture x86_64-pc-windows-msvc -Release
258258
259259
# Create MSIX private package
260-
./build.new.ps1 -PackageType msix-private -Architecture x86_64-pc-windows-msvc -Release
260+
./build.ps1 -PackageType msix-private -Architecture x86_64-pc-windows-msvc -Release
261261
262262
# Create MSIX bundle (builds both x64 and ARM64)
263-
./build.new.ps1 -PackageType msixbundle -Release
263+
./build.ps1 -PackageType msixbundle -Release
264264
265265
# Create ZIP package
266-
./build.new.ps1 -PackageType zip -Architecture x86_64-pc-windows-msvc -Release
266+
./build.ps1 -PackageType zip -Architecture x86_64-pc-windows-msvc -Release
267267
```
268268

269269
#### Linux/macOS Packages
270270

271271
```powershell
272272
# Create tar.gz package for Linux
273-
./build.new.ps1 -PackageType tgz -Architecture x86_64-unknown-linux-gnu -Release
273+
./build.ps1 -PackageType tgz -Architecture x86_64-unknown-linux-gnu -Release
274274
275275
# Create tar.gz package for macOS
276-
./build.new.ps1 -PackageType tgz -Architecture aarch64-apple-darwin -Release
276+
./build.ps1 -PackageType tgz -Architecture aarch64-apple-darwin -Release
277277
```
278278

279279
### Get Package Version
280280

281281
```powershell
282282
# Get the current version from Cargo.toml
283-
./build.new.ps1 -GetPackageVersion
283+
./build.ps1 -GetPackageVersion
284284
```
285285

286286
## CI/CD Workflows
@@ -327,18 +327,18 @@ To simulate the CI workflow locally:
327327

328328
```powershell
329329
# Install prerequisites and build with Clippy (matches CI)
330-
./build.new.ps1 -SkipBuild -Clippy -Verbose
331-
./build.new.ps1 -Clippy -Verbose
330+
./build.ps1 -SkipBuild -Clippy -Verbose
331+
./build.ps1 -Clippy -Verbose
332332
333333
# Run Rust tests (matches CI)
334-
./build.new.ps1 -SkipBuild -Test -ExcludePesterTests -Verbose
334+
./build.ps1 -SkipBuild -Test -ExcludePesterTests -Verbose
335335
336336
# Run Pester tests for a specific group (matches CI)
337-
./build.new.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup dsc -Verbose
337+
./build.ps1 -SkipBuild -Test -ExcludeRustTests -PesterTestGroup dsc -Verbose
338338
339339
# Test documentation (matches CI docs job)
340-
./build.new.ps1 -RustDocs -Verbose
341-
./build.new.ps1 -SkipBuild -RustDocs -Test -ExcludeRustTests -ExcludePesterTests -Verbose
340+
./build.ps1 -RustDocs -Verbose
341+
./build.ps1 -SkipBuild -RustDocs -Test -ExcludeRustTests -ExcludePesterTests -Verbose
342342
```
343343

344344
### Winget Workflow: winget.yml
@@ -365,24 +365,24 @@ If Rust is not installed:
365365
Ensure Visual Studio C++ build tools are installed:
366366
```powershell
367367
# The build script checks and provides guidance
368-
./build.new.ps1 -Verbose
368+
./build.ps1 -Verbose
369369
```
370370

371371
#### Tests Fail
372372

373373
Check that the build completed successfully:
374374
```powershell
375375
# Ensure clean build before testing
376-
./build.new.ps1 -Clean
377-
./build.new.ps1 -Clippy -Test
376+
./build.ps1 -Clean
377+
./build.ps1 -Clippy -Test
378378
```
379379

380380
#### Node.js or tree-sitter Missing
381381

382382
The build script automatically installs these. If issues persist:
383383
```powershell
384384
# Re-run with verbose output
385-
./build.new.ps1 -Verbose
385+
./build.ps1 -Verbose
386386
```
387387

388388
### Build Script Parameters Reference
@@ -415,7 +415,7 @@ The build script automatically installs these. If issues persist:
415415

416416
For detailed build information:
417417
```powershell
418-
./build.new.ps1 -Verbose
418+
./build.ps1 -Verbose
419419
```
420420

421421
### Getting Help
@@ -430,17 +430,17 @@ Before submitting a pull request, validate your changes with the following comma
430430

431431
```powershell
432432
# 1. Clean build with linting
433-
./build.new.ps1 -Clean -Clippy -Release
433+
./build.ps1 -Clean -Clippy -Release
434434
435435
# 2. Run all tests
436-
./build.new.ps1 -SkipBuild -Test
436+
./build.ps1 -SkipBuild -Test
437437
438438
# 3. Check for security vulnerabilities
439-
./build.new.ps1 -Audit
439+
./build.ps1 -Audit
440440
441441
# 4. Generate and test documentation (optional)
442-
./build.new.ps1 -RustDocs
443-
./build.new.ps1 -SkipBuild -RustDocs -Test -ExcludeRustTests -ExcludePesterTests
442+
./build.ps1 -RustDocs
443+
./build.ps1 -SkipBuild -RustDocs -Test -ExcludeRustTests -ExcludePesterTests
444444
```
445445

446446
This ensures your changes:

0 commit comments

Comments
 (0)