Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[development] Adding generic, maven based run and debug. #2435

Merged
merged 3 commits into from
Dec 30, 2024

Conversation

dalgwen
Copy link
Contributor

@dalgwen dalgwen commented Dec 27, 2024

With openhab/openhab-distro#1707

It is now possible to run the demo project with maven in a generic, non-ide related way.
All IDE can then leverage this to debug any openHAB component (core included).

I also made some modification to IntelliJ to use this.

Copy link

netlify bot commented Dec 27, 2024

Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

Built without sensitive environment variables

Name Link
🔨 Latest commit f217791
🔍 Latest deploy log https://app.netlify.com/sites/openhab-docs-preview/deploys/67725b6c1ca1b00008fab10c
😎 Deploy Preview https://deploy-preview-2435--openhab-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Also see openhab/openhab-distro#1707

Signed-off-by: Gwendal Roulleau <gwendal.roulleau@gmail.com>
Copy link
Contributor

@stefan-hoehn stefan-hoehn left a comment

Choose a reason for hiding this comment

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

Thanks for the amount of work you put into that! Take the review comments as an appreciation of the work. I did at least try out every step you wrote in generic.md and it worked out of the box! 🎉

In the beginning I was actually not finding that page and therefore I wonder if we should not add all IDE pages as subpages to the menu? (this can be done in docs-sidebar.js)

image

developers/index.md Show resolved Hide resolved
developers/ide/generic.md Show resolved Hide resolved
developers/ide/generic.md Outdated Show resolved Hide resolved
developers/ide/generic.md Outdated Show resolved Hide resolved
developers/ide/generic.md Outdated Show resolved Hide resolved
developers/ide/generic.md Show resolved Hide resolved
developers/ide/intellij.md Outdated Show resolved Hide resolved
developers/ide/intellij.md Outdated Show resolved Hide resolved
developers/ide/intellij.md Outdated Show resolved Hide resolved
- mvn clean install in the root of `<ADDON_DIR>` using commandline Maven (or IntelliJ Maven view)
- some of the add-ons might fail to build - if it's not the one, you're interested in that should not bother you
- when the Maven project finished, you should find the freshly built addon JAR in the target directory
This is the simpler option, but you can only use it for add-on development.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we should link to the generic page here?

Copy link
Contributor Author

@dalgwen dalgwen Dec 29, 2024

Choose a reason for hiding this comment

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

I don't get it, which generic page ?
In the line you cite, the "simpler option" mentionned is described just after (it's the 'old' way : just copy the addon jar in the addon directory)

Copy link
Contributor

Choose a reason for hiding this comment

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

developers/ide/generic.md

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The generic page is the option 2 section, and it already has a link.

@dalgwen
Copy link
Contributor Author

dalgwen commented Dec 29, 2024

Many thanks for your wise suggestions !

@dalgwen dalgwen force-pushed the main branch 2 times, most recently from 32aa45d to c1f183b Compare December 29, 2024 10:07
@dalgwen
Copy link
Contributor Author

dalgwen commented Dec 29, 2024

In the beginning I was actually not finding that page and therefore I wonder if we should not add all IDE pages as subpages to the menu? (this can be done in docs-sidebar.js)

I 100% agree with you. I added it, tell me what you think.

Apply MR comments

Signed-off-by: Gwendal Roulleau <gwendal.roulleau@gmail.com>
@stefan-hoehn
Copy link
Contributor

I 100% agree with you. I added it, tell me what you think.

Great, and it even worked (the config isn't that simple...) the first time.

image

If there is nothing left, I am happy to merge it now?

@stefan-hoehn stefan-hoehn added this to the 5.0 milestone Dec 29, 2024
Apply MR comments

Signed-off-by: Gwendal Roulleau <gwendal.roulleau@gmail.com>
@dalgwen
Copy link
Contributor Author

dalgwen commented Dec 30, 2024

Seems good to me now. Thanks !

Copy link
Contributor

@stefan-hoehn stefan-hoehn left a comment

Choose a reason for hiding this comment

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

Thanks @dalgwen for your effort! LGTM.

@stefan-hoehn stefan-hoehn merged commit 3298dc8 into openhab:main Dec 30, 2024
5 checks passed
@florian-h05
Copy link
Contributor

florian-h05 commented Dec 31, 2024

Many thanks for these awesome docs @dalgwen!

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.

3 participants