Skip to content

#1918: Add documentation on how to run IDEasy locally using intellij#1941

Merged
hohwille merged 8 commits into
devonfw:mainfrom
satorus:feature/1918-add-local-run-instructions-to-dev-doc
May 22, 2026
Merged

#1918: Add documentation on how to run IDEasy locally using intellij#1941
hohwille merged 8 commits into
devonfw:mainfrom
satorus:feature/1918-add-local-run-instructions-to-dev-doc

Conversation

@satorus
Copy link
Copy Markdown
Contributor

@satorus satorus commented May 13, 2026

This PR fixes #1918

Implemented changes:

  • Added documentation for contributors on how to run and debug IDEasy with local changes in Intellij.
  • Converted markdown listing style to asciidoc style (since intellij commit check was unhappy about it)

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

@github-project-automation github-project-automation Bot moved this to 🆕 New in IDEasy board May 13, 2026
@satorus satorus added documentation Improvements or additions to documentation enhancement New feature or request labels May 13, 2026
@satorus satorus self-assigned this May 13, 2026
@satorus satorus moved this from 🆕 New to Team Review in IDEasy board May 13, 2026
@satorus satorus marked this pull request as ready for review May 13, 2026 12:22
@areinicke areinicke self-assigned this May 13, 2026
@areinicke areinicke self-requested a review May 13, 2026 12:24
@coveralls
Copy link
Copy Markdown
Collaborator

coveralls commented May 13, 2026

Coverage Report for CI Build 26283982021

Coverage increased (+0.008%) to 71.123%

Details

  • Coverage increased (+0.008%) from the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • 1 coverage regression across 1 file.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

1 previously-covered line in 1 file lost coverage.

File Lines Losing Coverage Coverage
com/devonfw/tools/ide/version/VersionSegment.java 1 90.55%

Coverage Stats

Coverage Status
Relevant Lines: 15566
Covered Lines: 11546
Line Coverage: 74.17%
Relevant Branches: 6954
Covered Branches: 4471
Branch Coverage: 64.29%
Branches in Coverage %: Yes
Coverage Strength: 3.14 hits per line

💛 - Coveralls

Copy link
Copy Markdown
Contributor

@areinicke areinicke left a comment

Choose a reason for hiding this comment

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

Nice job! This should make it easier for new joiners or other people to test their changes. Please consider the one comment I left.

Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
@satorus satorus requested a review from areinicke May 15, 2026 11:30
Copy link
Copy Markdown
Contributor

@areinicke areinicke left a comment

Choose a reason for hiding this comment

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

Nice job! Your explanations are very detailed and it is easy to follow along. I have tested all the ways you provided and everything seems to be correct.

I have commented on some minor issues that should be resolved before merging.

Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
@satorus satorus force-pushed the feature/1918-add-local-run-instructions-to-dev-doc branch from 6ef7b22 to c9851a4 Compare May 18, 2026 08:11
@satorus satorus moved this from Team Review to 👀 In review in IDEasy board May 18, 2026
@satorus satorus requested a review from hohwille May 18, 2026 08:11
Copy link
Copy Markdown
Member

@hohwille hohwille left a comment

Choose a reason for hiding this comment

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

@satorus thank you for your nice documentation improvement. Looks very helpful for newbies 👍
I left some small suggestions for improvement.

Comment thread documentation/contributing/setup.adoc Outdated
Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
satorus and others added 7 commits May 21, 2026 12:32
Co-authored-by: Alexander Reinicke <167530118+areinicke@users.noreply.github.com>
Co-authored-by: Jörg Hohwiller <hohwille@users.noreply.github.com>
Revert back to previous source listing style
Added easier run without IDE example using mvn exec:exec
@satorus satorus force-pushed the feature/1918-add-local-run-instructions-to-dev-doc branch from 4e5e9fc to a44238d Compare May 21, 2026 10:33
@hohwille hohwille merged commit 22c5b14 into devonfw:main May 22, 2026
4 checks passed
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Done in IDEasy board May 22, 2026
@hohwille hohwille added this to the release:2026.05.001 milestone May 22, 2026
@hohwille hohwille added the QA approved Label a PR that has been re-testet via nightly SNAPSHOT after merge and commented. label May 22, 2026
@hohwille
Copy link
Copy Markdown
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request QA approved Label a PR that has been re-testet via nightly SNAPSHOT after merge and commented.

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

Onboarding documentation improvement

4 participants