Better documentation for using command line

[sebersole]

Perhaps my Google-fu simply blows, but I have been unable to find decent documentation/examples of running the transformer from the command line. All doc/examples I have been able to find make the assumption that there is an executable named JakartaTransformer. But they all gloss over where one gets this executable and how to make it executable (I assume the second will be trivial based on the first)

[sebersole]

I've actually seen both Transformer and JakartaTransformer as the command. But still never any explanation of the set up.

[reinhapa]

I got the same problem here, it would be great to have some samples on how to migrate a existing source base using the CLI. The only hint I saw was in presentation of @Emily-Jiang at the MicroProfile 4.1, 5.0 and beyond | JakartaOne Livestream 2021 presentation

[bjhargrave]

I have done a major refactoring and, in the latest code, the main CLI class for Jakarta transformation is now org.eclipse.transformer.cli.JakartaTransformerCLI.

You can run

mvn exec:java --file=org.eclipse.transformer.cli -Dexec.arguments="--help" 

to see the CLI help. More work is needed, but this where things currently stand.

[Emily-Jiang]

Thanks @bjhargrave ! It might be a good idea to put the above comment on readme of this repo so that people can find it easily. When you improve it further, you can update the readme as you go along.

[reinhapa]

@sebersole does my addition in usage help for the command line?

[jheadley]

In case it helps anyone else, I was able to finally make progress by using https://github.com/navikt/dev-jakarta-transform to help me get the job done. After cloning that repo, change the transformer's version in that project's pom.xml to "0.5.0", then follow the steps as outlined. Thank you to the navikt team for making that available.

[bjhargrave]

I would recommend anyone use the maven plugin instead of the CLI if they want to integrate transforming into a maven build.

[escay]

Too bad the main page of the transformer project does not link to the https://github.com/eclipse/transformer/tree/main/maven-plugins/transformer-maven-plugin documentation directly. I stumbled upon it by finding the transformer-maven-plugin in the maven repository and searching for the source code on how to use it.

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. Given the limited bandwidth of the team, it will be automatically closed if no further activity occurs. If you feel this is something you could contribute, please have a look at our Contributor Guide. Thank you for your contribution.

[github-actions[bot]]

This issue has been automatically closed due to inactivity. If you can reproduce this or if you have a good use case for this feature, please feel free to reopen the issue with steps to reproduce, a quick explanation of your use case or a high-quality pull request.