Add Windows OS build and deployment#5
Merged
Merged
Conversation
Updated formatting and clarified instructions in README.
Co-authored-by: jody <379845+jody@users.noreply.github.com>
Update the ant build script (build.xml) and the GitHub build action (.github/workflows/build.yaml). Construct and add appropriate Windows icon file (icon.ico). Add explanation and instructions to readme file (README.md).
One target now reflects the general usage api. The other target shows all members, including protected and private.
…ags. Hid the constructor to indicate Main is a utility class.
jody
added
documentation
jody
commented
Dec 25, 2025
There was a problem hiding this comment.
Pull request overview
This PR adds Windows support to the native application build and deployment process, enabling the creation of MSI installers alongside existing macOS DMG and Linux DEB packages. Additionally, it refactors the Ant build script's javadoc generation to use a parameterized macro, allowing both standard API documentation and internal documentation (including private members) to be generated.
Key changes:
- Adds Windows MSI installer build target with WiX Toolset integration
- Refactors javadoc generation into a reusable macrodef with configurable access levels
- Updates documentation with Windows-specific setup instructions and requirements
- Adds Windows runner to GitHub Actions CI/CD pipeline
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/Main.java | Adds version tag, author tag, and private constructor following utility class pattern |
| build.xml | Introduces javadoc macrodef for parameterized documentation generation; adds Windows OS detection, icon.ico support, and windows target for MSI creation; adds javadoc-internal and javadoc-all targets |
| README.md | Expands documentation with Windows setup instructions, WiX Toolset requirements, icon.ico asset details, and updates all platform references to include Windows |
| .github/workflows/build.yaml | Adds windows-latest to OS matrix and includes .msi artifacts in release assets |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jody
commented
Dec 25, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This was
linked to
issues
Dec 25, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add build and packaging into the Ant and GitHub build processes.
Side-effect: Refactor build.xml handling of javadoc task to allow for parameterized generation.