sdkman / sdkman-vendor-gradle-plugin

A plugin for Gradle to allow Vendors to release Candidate Versions on SDKMAN!
Apache License 2.0
15 stars 12 forks source link

Vendor keys for ktx #16

Closed mpetuska closed 1 year ago

mpetuska commented 1 year ago

Hi, I'm currently working on mpetuska/ktx to bring npx capabilities to kotlin scripting ecosystem. The project is nearing first dev preview release and I'm wondering if now would be a good time to integrate with sdkman to avoid wasting time on selfinstall scripts. If so, I'd need a set of vendor secrets, please.

mpetuska commented 1 year ago

Additionally I'd like some guidance on how to package qn artefact for sdkman platform and gow to specify which paths should be appended.

marc0der commented 1 year ago

Hi @mpetuska, you are welcome to follow the process outlined here.

mpetuska commented 1 year ago

Hi, the linked page outlines obtaining vendor keys perfectly, thanks. Do you have similar documentation on what is the "well formed sdk archive" mentioned there?

helpermethod commented 1 year ago

Hi @mpetuska,

well formed SDK archive basically means:

ktx-0.1.0/ <-- the top level directory
    |
    -- bin/
       |
       `-- ktx <-- ktx binary or shell script
    README.md <-- optional
    License.txt <-- optional

Sorry I'm on my phone, so limited drawing capabilities 😁.

mpetuska commented 1 year ago

The drawing is awesome! That looks like what gradle's application plugin spits out in distZip. So far so good, but ktx relies on adding a particular directory to user's PATH to work. Is there any way to tell sdkman to do so?

marc0der commented 1 year ago

SDKMAN will add the bin folder of the currently selected version to the PATH automatically. We don't provide a way to add other custom directories to the path, so your users would need to do it themselves.

marc0der commented 1 year ago

So after this, I've finally done it! I've written a wiki page that describes what a well-formed archive is. I hope this helps you and any fellow travellers in the future @mpetuska :smile:

Please don't hesitate to contact us on our community slack #vendors channel if you have any questions about onboarding your candidate.