Skip to content

#1558: added new text about installation log path to installation dialog and exit dialog - #2076

Merged
hohwille merged 14 commits into
devonfw:mainfrom
JoelAdbu:feature/1558-add-install-log-to-msi-window
Aug 7, 2026
Merged

#1558: added new text about installation log path to installation dialog and exit dialog#2076
hohwille merged 14 commits into
devonfw:mainfrom
JoelAdbu:feature/1558-add-install-log-to-msi-window

Conversation

@JoelAdbu

@JoelAdbu JoelAdbu commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

This PR fixes #1558

Implemented changes:

  • added new text about installation log path to installation dialog
  • added new text about installation log path to exit dialog
  • added new documentation about installation log path in documentation/setup.adoc

Testing instructions

Please add conscise, understandable instructions on how a reviewer can test/verify the functionality of your contribution here:

  1. Prerequisites:

    • A GraalVM installation with native-image is required to build the IDEasy native executable.
    • Follow the setup instructions in:
      documentation/contributing/GraalVM-Build-Guide.adoc
    • Note: The Visual Studio Build Tools should currently be downloaded fdirectly from Microsoft if the referenced link is outdated.
  2. Build the MSI package

    • Follow the instructions in:
      windows-installer/README.adoc
    • Build the MSI using the documented WiX Toolset worklfow.
  3. Verify the installer UI

    • Launch the generated ideasy.msi
    • Navigate to the "Select Project Folder" dialog.
    • Verify that the installation log location is displayed (on the bottom).
  4. Verify the installation log location:

    • Complete the installation.
    • Verify that installation logs are written to:
      %USERPROFLIE%\.ide\logs
    • Confirm that a timestamped log ifle such as install-2026-07-01_10-15-00.log is created.
  5. Verify documentation

    • Review the updated installation log section in the MSI documentation.

Checklist for this PR

Make sure everything is checked before merging this PR. For further info please also see
our DoD.

  • When running mvn clean test locally all tests pass and build is successful
  • PR title is of the form #«issue-id»: «brief summary» (e.g. #921: fixed setup.bat). If no issue ID exists, title only.
  • PR top-level comment summarizes what has been done and contains link to addressed issue(s)
  • PR and issue(s) have suitable labels
  • Issue is set to In Progress and assigned to you or there is no issue (might happen for very small PRs)
  • You followed all coding conventions
  • You have added the issue implemented by your PR in CHANGELOG.adoc unless issue is labeled
    with internal
  • You have formulated clear instructions on how to test your contribution under "Testing instructions"

@coveralls

coveralls commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 31185771056

Warning

No base build found for commit 80de93e on main.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 72.896%

Details

  • Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 17500
Covered Lines: 13305
Line Coverage: 76.03%
Relevant Branches: 7729
Covered Branches: 5086
Branch Coverage: 65.8%
Branches in Coverage %: Yes
Coverage Strength: 3.23 hits per line

💛 - Coveralls

@JoelAdbu
JoelAdbu marked this pull request as ready for review July 1, 2026 06:33
@JoelAdbu JoelAdbu self-assigned this Jul 1, 2026
@JoelAdbu JoelAdbu added enhancement New feature or request install installation process of IDE + tools and install commandlet windows specific for Microsoft Windows OS labels Jul 1, 2026
@JoelAdbu JoelAdbu moved this from 🆕 New to 🏗 In progress in IDEasy board Jul 1, 2026
@JoelAdbu JoelAdbu moved this from 🏗 In progress to Team Review in IDEasy board Jul 1, 2026
@vivu001

vivu001 commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Tested the changes following the provided instructions:

  1. Installer UI: Confirmed installation log location is displayed in the "Select Project Folder" dialog
image
  1. Log file creation: Verified timestamped log file .log was successfully created in %USERPROFILE%\.ide\logs
  2. Reviewed updated setup.adoc
  3. Build verification: mvn clean test passed
[INFO] Reactor Summary:
[INFO]
[INFO] ide dev-SNAPSHOT ................................... SUCCESS [  0.534 s]
[INFO] ide-doc 2026.07.001-SNAPSHOT ....................... SUCCESS [07:11 min]
[INFO] ide-cli 2026.07.001-SNAPSHOT ....................... SUCCESS [03:25 min]
[INFO] ide-gui 2026.07.001-SNAPSHOT ....................... SUCCESS [ 18.900 s]
[INFO] url-updater 2026.07.001-SNAPSHOT ................... SUCCESS [ 26.288 s]
[INFO] ide-security 2026.07.001-SNAPSHOT .................. SUCCESS [  5.716 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  11:28 min

@vivu001 vivu001 moved this from Team Review to 👀 In review in IDEasy board Jul 6, 2026
@JoelAdbu
JoelAdbu force-pushed the feature/1558-add-install-log-to-msi-window branch 2 times, most recently from 56f9da6 to 18c1d7e Compare July 22, 2026 07:34
@hohwille hohwille added this to the release:2026.08.001 milestone Jul 23, 2026

@hohwille hohwille left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@JoelAdbu thanks for your PR. Nice enhancement for our MSI installer. 👍
Did you test this? I am slightly confused by the [USERFOLDER].ide\logs syntax since in all existing places we are using [%USERPROFILE]\.ide\logs. Does the latter not work to stay homogenous and avoid such confusion?
Apart from some tiny format review comments ready for merge.

Comment thread documentation/setup.adoc Outdated
Comment thread documentation/setup.adoc Outdated
Comment thread documentation/setup.adoc Outdated
Comment thread windows-installer/WixUI_IDEasySetup.wxs Outdated
@JoelAdbu

Copy link
Copy Markdown
Contributor Author

@hohwille, yes I tested it. %USERPROFILE% was shown literally in the dialog and was not resolved to the actual user directory. Therefore I switched to [USERFOLDER], which is populated via DirectorySearch and gets resolved correctly in the MSI UI.

@JoelAdbu
JoelAdbu requested a review from hohwille July 24, 2026 10:40
@JoelAdbu
JoelAdbu force-pushed the feature/1558-add-install-log-to-msi-window branch 4 times, most recently from 02e5ea4 to d2997dd Compare August 4, 2026 11:26
JoelAdbu and others added 7 commits August 6, 2026 14:02
… and exit dialog

added doc about installation log path
- small fixes in path
- add changelog
- added msi installation log doc to documentation\setup.adoc
- deleted msi installation log documentation from README.adoc
JoelAdbu and others added 5 commits August 6, 2026 14:02
Co-authored-by: Jörg Hohwiller <hohwille@users.noreply.github.com>
Co-authored-by: Jörg Hohwiller <hohwille@users.noreply.github.com>
Co-authored-by: Jörg Hohwiller <hohwille@users.noreply.github.com>
- reformatted code (review request)
@JoelAdbu
JoelAdbu force-pushed the feature/1558-add-install-log-to-msi-window branch from d2997dd to 9829044 Compare August 6, 2026 12:03

@hohwille hohwille left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@JoelAdbu thank you for your PR and improving our installer UX. 👍
Great that you also properly formatted our MSI XML files.
In this PR this makes the diff a little hard to read but in the future this will help us very much.
Since this was tested already in team review, I only checked the obvious changes and all looks good to me. Ready for merge.

@hohwille
hohwille merged commit 8708ee9 into devonfw:main Aug 7, 2026
3 checks passed
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Done in IDEasy board Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request install installation process of IDE + tools and install commandlet windows specific for Microsoft Windows OS

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

Add install.log path to msi installer window

4 participants