Update CONTRIBUTING.md to enhance build instructions and component-sp… #201
Conversation
…ecific build guidance
tonygermano
left a comment
tonygermano
left a comment
There was a problem hiding this comment.
I've got a couple suggestions, but overall this looks great. Thank you for contributing!
CONTRIBUTING.md
Outdated
| **Full Build (Development)** | ||
| ```bash | ||
| cd server | ||
| ant -f mirth-build.xml -DdisableSigning=true |
There was a problem hiding this comment.
We have also added a -DdisableTests=true property that can be set to skip running tests as part of the build if you would like to add a section about that. See #141
There was a problem hiding this comment.
Hi, I have added a section for these tests.
| cd server | ||
| ant -f mirth-build.xml dist | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Maybe add a section about starting the server after building? I see further down you indicated that server/setup is where the application is "installed" post-build. As of #119 there will be an oieserver bash script for linux/mac developers and oieserver.ps1 powershell script for windows developers placed in server/setup to launch the server with that will correctly pick up the vmoptions.
There was a problem hiding this comment.
Hi, actually, I tried to start the client ... and the old java webstart was an issue. So i decided to upgrade the whole thing to a more recent JAVA, the 21. I updated the CONTRIBUTING.md to give running instructions. I added an oieclient script based on the oeiserver script.
https://github.com/charEtoile/engine/blob/update_sdk_to_21/CONTRIBUTING.md
I know that current tests fail, i am investigating.
There was a problem hiding this comment.
As things currently stand, the project must compile with java 8, but the oieserver script requires the server is started with java 17 or higher. There are a couple work in progress PRs that will require java 17 for the build version, and 17 or higher for the runtime version.
There was a problem hiding this comment.
OK.
I reverted back to Java 8 and added instructions for Java 17 runtime. All build tests pass.
I also added the oieclient script. Hope this is enough.
…ption -DdisableTests=true
…cy (make it run with 17.0.17.fx-zulu)
…n instructions; add images for client GUI
2 participants
Update CONTRIBUTING.md to enhance build instructions