refactor: rename ege-setup to ege-installer for clarity#11
Conversation
- Rename output file from ege-setup-*.exe to ege-installer-*.exe - Update all documentation references (README, INSTALLATION.md) - Update build scripts and CI workflow - Aligns filename with project name for better consistency
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Renames the generated installer executable from ege-setup-*.exe to ege-installer-*.exe to better match the project naming and improve clarity across build outputs, CI artifacts, and docs.
Changes:
- Updated NSIS
OutFileto produceege-installer-${VERSION}.exe. - Updated PowerShell build script to expect/validate
ege-installer-$Version.exe. - Updated CI artifact name and user/developer documentation references to the new filename.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
scripts/installer.nsi |
Changes NSIS output filename to ege-installer-${VERSION}.exe. |
scripts/build.ps1 |
Updates final output path check/logging to ege-installer-$Version.exe. |
README.md |
Updates download and build output references to ege-installer-*.exe. |
INSTALLATION.md |
Updates user-facing instructions/examples to ege-installer-*.exe. |
.github/workflows/build.yml |
Renames uploaded artifact to ege-installer-${VERSION}. |
🤖 Augment PR SummarySummary: Renames the generated installer from Changes: Updates CI artifact naming, NSIS 🤖 Was this summary useful? React with 👍 or 👎 |
- Detect EGE libs from both ../xege_libs and .. (parent directory) - Add Test-EgeLibsDirectory function to validate directory structure - Check for required files: include/ege.h, lib/, version.txt - Show helpful error message with searched paths if not found - Enables building from within xege-sdk project without manual path config
Motivation
The current output filename
ege-setup-*.execreates semantic confusion:ege-installer) and build script (build-installer.sh)Changes
1. Filename Rename
Before:
ege-setup-<version>.exeAfter:
ege-installer-<version>.exeUpdated references in:
scripts/installer.nsi- NSIS OutFile directivescripts/build.ps1- Output path validation.github/workflows/build.yml- Artifact namingREADME.md- Download instructions and build output docsINSTALLATION.md- User guide references (3 locations)2. Smart EGE Libs Path Detection
Added intelligent auto-detection for EGE library directory:
Candidate paths (tried in order):
../xege_libs(default, for standalone ege-installer)..(parent directory, for building within xege-sdk project)Validation: New
Test-EgeLibsDirectoryfunction checks:include/ege.hexistslib/directory existsversion.txtexistsBenefits:
Benefits
✅ Aligns filename with project name for consistency
✅ Clearer semantic meaning ("installer" vs "setup")
✅ Better search discoverability
✅ Matches Windows installer naming conventions
✅ Auto-detects EGE libs from multiple locations
Compatibility
This is a breaking change for automated scripts that reference the old filename. Recommend coordinating release with dependent projects (e.g., xege-sdk).
Related PR: x-ege/xege-sdk#74