Skip to content

🔄 Updated prerequisites build configuration and setup files with enhanced documentation and branding Converts from ant->gradle build systems #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jwaisner merged 2 commits into from
Nov 27, 2025
Merged

🔄 Updated prerequisites build configuration and setup files with enhanced documentation and branding Converts from ant->gradle build systems #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48d0629
🔄 Updated prerequisites build configuration and setup files with enha…
N6REJ Nov 26, 2025
746b65e
🔄 Added font installation support to setup script with Cascadia Cove …
jwaisner Nov 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
237 changes: 237 additions & 0 deletions .gradle-docs/GRADLE_BUILD_SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,237 @@
# Prerequisites Module - Gradle Build Summary

## Status: ✅ COMPLETE

The Gradle build implementation is complete and ready for use.

---

## Quick Start

```bash
# Verify build environment
gradle verify

# Build prerequisites installer
gradle release

# Show build information
gradle info

# Clean build artifacts
gradle clean
```

---

## Key Features

### ✅ Complete Ant Migration
All functionality from the original Ant build has been migrated:
- Properties loading from build.properties
- Path resolution and configuration
- Source and setup file copying
- Token replacement in setup.iss
- Inno Setup compiler execution
- Hash file generation (enhanced with multiple algorithms)

### ✅ Dev Module Integration
- Correctly references dev module at `../dev`
- Uses tool paths from `dev/bin/lib/` structure
- Compatible with dev module's `loadLibs` task
- Tool path: `dev/bin/lib/innosetup/ISCC.exe` ✅ FIXED

### ✅ Tool Path Access
As noted by Qodo, tool paths are available via `rootProject.ext.innosetupCompiler` when used as a subproject. Current implementation:

```groovy
// Standalone mode (current)
ext.innosetupPath = file("${devPath}/bin/lib/innosetup")
ext.isccExe = file("${innosetupPath}/ISCC.exe")

// Note: Tool paths are available via rootProject.ext.innosetupCompiler
// when used as a subproject
```

### ✅ Enhanced Features
Beyond the original Ant build:
- **Verification Task**: Validates environment before building
- **Info Task**: Displays configuration and usage
- **Better Error Handling**: Clear, actionable error messages
- **Multiple Hash Algorithms**: MD5, SHA1, SHA256, SHA512
- **Formatted Output**: Professional build messages

---

## Build Configuration

### Properties (build.properties)
```properties
prerequisites.release = 2025.7.31
prerequisites.id = prerequisites
prerequisites.name = Bearsampp Prerequisites Package
prerequisites.setupname = Bearsampp-prerequisites-${prerequisites.release}
```

### Build Paths
Priority order:
1. `build.path` in build.properties
2. `BEARSAMPP_BUILD_PATH` environment variable
3. Default: `{root}/bearsampp-build`

---

## Dependencies

### Required Tools (from dev module)
Ensure dev module's `loadLibs` task has been run:
```bash
cd ../dev
gradle loadLibs
```

This downloads and sets up:
- Inno Setup (ISCC.exe)
- InnoExtract
- Composer
- HashMyFiles
- LessMSI

### Required Source Files
- `src/fonts/CaskaydiaCoveNerdFont-Regular.ttf`
- `src/vcredist_2015_2022/VC_redist.x86.exe`
- `src/vcredist_2015_2022/VC_redist.x64.exe`

---

## Verification Results

```
Environment Check Results:
------------------------------------------------------------
[PASS] Java 8+
[PASS] build.properties
[PASS] src directory
[PASS] setup directory
[PASS] setup.iss
[PASS] dev directory
[PASS] Inno Setup
[PASS] CaskaydiaCove Nerd Font
[PASS] VC++ Redist x86
[PASS] VC++ Redist x64
------------------------------------------------------------

[SUCCESS] All checks passed! Build environment is ready.
```

---

## Build Output

When running `gradle release`, the build produces:
- **Installer**: `{build-path}/prerequisites/Bearsampp-prerequisites-{version}.exe`
- **Hash Files**:
- `.md5` - MD5 checksum
- `.sha1` - SHA1 checksum
- `.sha256` - SHA256 checksum
- `.sha512` - SHA512 checksum

---

## Comparison with Ant Build

| Feature | Ant | Gradle |
|---------|-----|--------|
| Build properties | ✅ | ✅ |
| Path resolution | ✅ | ✅ |
| Dev integration | ✅ | ✅ |
| File copying | ✅ | ✅ |
| Token replacement | ✅ | ✅ |
| Inno Setup execution | ✅ | ✅ |
| Hash generation | Basic | Enhanced |
| Environment verification | ❌ | ✅ |
| Error handling | Basic | Enhanced |
| Documentation | ❌ | ✅ |

---

## Migration Notes

### What Changed
1. **Tool Path**: Fixed from `innosetup/app/ISCC.exe` to `innosetup/ISCC.exe`
2. **Hash Generation**: Enhanced with multiple algorithms
3. **Verification**: Added comprehensive environment checks
4. **Error Messages**: Improved clarity and actionability

### What Stayed the Same
1. Build properties format
2. Source file structure
3. Setup.iss token replacement
4. Output file naming
5. Build directory structure

---

## Troubleshooting

### Inno Setup Not Found
```bash
# Run dev module's loadLibs task
cd ../dev
gradle loadLibs
```

### Missing Source Files
Download required files:
- **Font**: https://github.com/ryanoasis/nerd-fonts/releases/latest
- **VC++ Redist**: https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist

### Build Path Issues
Set custom build path:
```properties
# In build.properties
build.path = C:/custom-build-path
```

Or use environment variable:
```bash
set BEARSAMPP_BUILD_PATH=C:/custom-build-path
```

---

## Next Steps

### Current Usage (Standalone)
The module works perfectly as a standalone Gradle project:
```bash
cd prerequisites
gradle release
```

### Future Integration (Subproject)
When included in dev/settings.gradle:
```groovy
// In dev/settings.gradle
include 'prerequisites'
project(':prerequisites').projectDir = file('../prerequisites')
```

Then can be built from dev:
```bash
cd dev
gradle :prerequisites:release
```

And can use `rootProject.ext.innosetupCompiler` for tool paths.

---

## Conclusion

✅ **Migration Complete**: All Ant functionality migrated
✅ **Verified**: Build environment passes all checks
✅ **Enhanced**: Additional features improve usability
✅ **Ready**: Production-ready for building prerequisites installer

**The Gradle build implementation is complete and ready for use.**
Loading