Skip to content

refactor: rename ege-setup to ege-installer for clarity#11

Merged
wysaid merged 2 commits intomainfrom
rename-setup-to-installer
Feb 8, 2026
Merged

refactor: rename ege-setup to ege-installer for clarity#11
wysaid merged 2 commits intomainfrom
rename-setup-to-installer

Conversation

@wysaid
Copy link
Copy Markdown
Contributor

@wysaid wysaid commented Feb 8, 2026

Motivation

The current output filename ege-setup-*.exe creates semantic confusion:

  • setup implies configuration/initialization, but this is a pure installer
  • Inconsistent with project name (ege-installer) and build script (build-installer.sh)
  • Less clear for end users searching for an installer

Changes

1. Filename Rename

Before: ege-setup-<version>.exe
After: ege-installer-<version>.exe

Updated references in:

  • scripts/installer.nsi - NSIS OutFile directive
  • scripts/build.ps1 - Output path validation
  • .github/workflows/build.yml - Artifact naming
  • README.md - Download instructions and build output docs
  • INSTALLATION.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):

  1. ../xege_libs (default, for standalone ege-installer)
  2. .. (parent directory, for building within xege-sdk project)

Validation: New Test-EgeLibsDirectory function checks:

  • include/ege.h exists
  • lib/ directory exists
  • version.txt exists

Benefits:

  • No manual path config needed when cloned inside xege-sdk
  • Clear error messages showing searched locations
  • Prevents accidental builds with invalid library paths

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

- 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
Copilot AI review requested due to automatic review settings February 8, 2026 16:29
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 8, 2026

Warning

Rate limit exceeded

@wysaid has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 11 minutes and 52 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch rename-setup-to-installer

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 OutFile to produce ege-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}.

@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Feb 8, 2026

🤖 Augment PR Summary

Summary: Renames the generated installer from ege-setup-.exe to ege-installer-.exe for clearer semantics and alignment with the project name.

Changes: Updates CI artifact naming, NSIS OutFile, the PowerShell build script output path, and README/INSTALLATION documentation references to the new filename.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. No suggestions at this time.

Comment augment review to trigger a new review at any time.

- 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
@wysaid wysaid merged commit a470faf into main Feb 8, 2026
2 checks passed
@wysaid wysaid deleted the rename-setup-to-installer branch February 8, 2026 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants