Convert to multiplatform #11

fullkomnun · 2021-01-14T11:22:46Z

An attempt to convert the library to Kotlin multiplatform:

Initially targeting jvm and js
Part of an overall effort to convert KHash and eventually KEthereum following the previous effort
but targeting Gradle Kotlin DSL
Follows the best practices for Kotlin DSL with buildSrc
Inspired by "Kotlin Multiplatform And Github Actions" and it's companion template repo
The main issue is that Jitpack is not compatible with KMP
and while GitHub Actions can be a great fit for CI, GitHub Packages has limitations that makes it useless for OSS with no apparent resolution so far
Bintray or sonatype/maven central could be alternatives

ligi

Thanks!

fullkomnun · 2021-01-16T20:35:52Z

Enabled strict 'explicitApi' mode for all modules

ligi · 2021-01-16T22:27:18Z

hey - wondering why you closed the PR?

fullkomnun · 2021-01-16T23:38:42Z

Closed by mistake

fullkomnun · 2021-01-25T05:02:04Z

Meanwhile, for development purposes, Github Packages may be used as a maven repository that supports Kotlin MP using this ugly workaround(https://github.community/t/download-from-github-package-registry-without-authentication/14407/44).

Are any changes required in the CI to build Kotlin MP projects?

ligi · 2021-01-25T07:15:47Z

"CO" ?

fullkomnun · 2021-01-25T07:18:12Z

"CO" ?

CI, fixed the typo =]

ligi · 2021-01-25T07:21:43Z

ah guessed so but was not sure - the CI is just executing gradle commands - but I would also be open to add Github Actions here if this would be easier. I would prefer github packages over maven central / bintray - eve though the workaround looks ugly ..
So far I am only targeting the JVM - but think there is value in supporting Kotlin MP.

fullkomnun · 2021-01-25T07:34:50Z

Yes, I focus on adding JS(browser, node) as an additional target for my use-case, besides JS is quite popular in the blockchain domain. Other targets such as iOS or other native targets may be added later..

ligi · 2021-01-25T07:36:26Z

Cool - completely agree that JS would be the most interesting target currently.

fullkomnun · 2021-01-31T12:35:54Z

By the way, why is the root package 'org.komputing.khex' while the artifact is published under 'com.github.komputing.khex'?

ligi · 2021-01-31T12:47:30Z

because I do not want to bind to github too much. Really hope in the future we can have something equally user-friendly but decentralized and not in the hand of Microsoft ;-)
Looking at radicle e.g.
github is just the current gateway and involved in deployment. But it is not forever. But I have control over komputing - and this is a constant I do not want to change.
But good thinking! Keep up the good work!!

Convert to multiplatform

…onvert_to_multiplatform # Conflicts: # .github/workflows/release.yml

fullkomnun · 2021-02-08T16:20:52Z

@ligi The conversion is complete including usage of GitHub Actions workflows:

Pull Request Check (pr-check.yml): triggered for PRs to master, builds project and runs tests, uploads report in case of failure
Continuous Integration (continuous-integration.yml) triggered for push to master, builds project and runs tests, uploads report in case of failure and uploads artifacts to GitHub Packages with version of 'master-SNAPSHOT'
Release (release.yml): triggered for GitHub release creation, builds project and runs tests, uploads report in case of failure and uploads artifacts to GitHub Packages with version according to the release/tag

This allows deploying kotlin multiplatform artifacts to GitHub Packages while also supporting jitpack for jvm-only variant.
You can see this ci in action in my fork.
KHash also already converted and fetches it's KHex multiplatform dependencies from GitHub Packages using this workaround.
Any maven/gradle project can use the same public credentials from README.md to download the packages.

Before this can be declared 'ready' I need you to perform the following:

Make sure to enable GitHub Actions for the original repository (if not enabled)
Create a 'machine user' according to these instructions and add it to the repo/organisation as a collaborator/outside-collaborator.
Create a PAT with the read:packages scope for that 'machine user'.
Run docker run jcansdale/gpr encode <PAT>
Share the output so I can update the encoded token and READEME.md
(I did it for my forks but you have to this once for the original repos)

ligi

Great work - just the repo needs to be changed in some part of the docs. Will do the steps for the machine user you outlined later today.

ligi · 2021-02-15T07:51:22Z

README.md

@@ -1,16 +1,46 @@
+![CI](https://github.com/fullkomnun/KHex/workflows/Continuous%20Integration/badge.svg)


Suggested change

![CI](https://github.com/fullkomnun/KHex/workflows/Continuous%20Integration/badge.svg)

![CI](https://github.com/komputing/KHex/workflows/Continuous%20Integration/badge.svg)

ligi · 2021-02-15T07:52:33Z

README.md

+```kotlin
+repositories {
+    maven {
+        name = "fullkomnun/KHex GitHub Packages"


Suggested change

name = "fullkomnun/KHex GitHub Packages"

name = "komputing/KHex GitHub Packages"

ligi · 2021-02-15T07:53:00Z

README.md

+repositories {
+    maven {
+        name = "fullkomnun/KHex GitHub Packages"
+        url = uri("https://maven.pkg.github.com/fullkomnun/KHex")


Suggested change

url = uri("https://maven.pkg.github.com/fullkomnun/KHex")

url = uri("https://maven.pkg.github.com/komputing/KHex")

ligi · 2021-02-16T14:40:59Z

Sorry it takes a bit longer. The step of creating a user dragged in the need to setup email for komputing.org

ligi · 2021-02-19T19:52:31Z

@fullkomnun sorry for the delay - here the output:

A NuGet `nuget.config` file:
<packageSourceCredentials>
  <github>
    <add key="Username" value="PublicToken" />
    <add key="ClearTextPassword" value="&#57;&#50;&#55;&#52;&#49;&#100;&#56;&#51;&#100;&#54;&#57;&#97;&#99;&#97;&#102;&#49;&#98;&#52;&#97;&#48;&#52;&#53;&#51;&#97;&#99;&#50;&#54;&#56;&#54;&#98;&#54;&#50;&#53;&#101;&#52;&#97;&#101;&#52;&#50;&#98;" />
  </github>
</packageSourceCredentials>

A Maven `settings.xml` file:
<servers>
  <server>
    <id>github</id>
    <username>PublicToken</username>
    <password>&#57;&#50;&#55;&#52;&#49;&#100;&#56;&#51;&#100;&#54;&#57;&#97;&#99;&#97;&#102;&#49;&#98;&#52;&#97;&#48;&#52;&#53;&#51;&#97;&#99;&#50;&#54;&#56;&#54;&#98;&#54;&#50;&#53;&#101;&#52;&#97;&#101;&#52;&#50;&#98;</password>
  </server>
</servers>

An npm `.npmrc` file:
@OWNER:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken="\u0039\u0032\u0037\u0034\u0031\u0064\u0038\u0033\u0064\u0036\u0039\u0061\u0063\u0061\u0066\u0031\u0062\u0034\u0061\u0030\u0034\u0035\u0033\u0061\u0063\u0032\u0036\u0038\u0036\u0062\u0036\u0032\u0035\u0065\u0034\u0061\u0065\u0034\u0032\u0062"

fullkomnun · 2021-02-21T00:54:18Z

Ready to go, if everything goes well - KHash will follow

ligi · 2021-02-21T01:02:49Z

cool - unfortunately there seems to be a problem with actions: https://github.com/komputing/KHex/runs/1944045614

Was just waiting for my old CI and it was happy - should have waited for the actions also - remembering for next time ..-)

fullkomnun · 2021-02-21T01:05:18Z

Yes, CI has built and ran tests successfully but publication has failed, although i do see published artifacts for 'master-SNAPSHOT'. Can you re-run the CI workflow maybe?

ligi · 2021-02-21T01:19:02Z

cool - yea the rerun worked

fullkomnun · 2021-02-21T01:24:25Z

And I was able to fetch it from my KHash fork using the credentials so pushed the changes.
Currently though it targets 'master-SNAPSHOT', for it to target a stable release you have to create a new GitHub release.
Both the old ci/Jitpack and the new GitHub Actions/Packages should work in tandem keeping it backwards-compatible.

ligi · 2021-02-21T01:36:59Z

Released 1.1.0

fullkomnun added 6 commits December 23, 2020 17:33

update gradle v6.0.1 -> v6.6.1

bc64b1f

update kotlin v1.3.61 -> v1.4.21

e01af85

prepare buildSrc and gradle.properties to go multiplatform

95e529f

update gradle v6.6.1 -> v6.7.1

0d5f7ed

converted to multiplatform with jvm and nodeJS targets

ad9b8a5

configure 'com.github.ben-manes.versions' gradle plugin

52afdf2

ligi approved these changes Jan 14, 2021

View reviewed changes

enabled strict 'explicitApi' mode for all modules

3429317

use Kotlin DSL extension of 'tasks.named(...)' to avoid IDE errors

c404e56

fullkomnun closed this Jan 16, 2021

fullkomnun reopened this Jan 16, 2021

fullkomnun mentioned this pull request Jan 25, 2021

Convert to multiplatform komputing/KHash#21

Merged

fullkomnun added 2 commits January 31, 2021 11:41

increase mocha tests timeout to 10s

fefd453

add js browser target

ec98a74

fullkomnun added 5 commits February 5, 2021 20:34

set jvm test target to 1.8 (default is 1.6)

79c0e66

update kotlin v1.4.21 -> v.1.4.30

d6981bd

remove js browser target and avoid setting jvmTarget for now

20989d8

remove *.gradle files from older multiplatform implementation

41e97a9

update gradle v6.7.1 -> v6.8.1

d1ceef2

fullkomnun and others added 13 commits February 8, 2021 02:42

update README.md for multiplatform support

88ee2b2

make suer maven 'groupId' of published modules is in lowercase

9c112e9

Merge pull request #3 from fullkomnun/convert_to_multiplatform

27671e1

Convert to multiplatform

add CI badge to README.md

24be71c

add a github release workflow

2d9e198

Merge pull request #4 from fullkomnun/convert_to_multiplatform

c0b9b72

Convert to multiplatform

Update release.yml

1cf913c

Update mpp-module.gradle.kts

974526d

pass 'version' property to gradle when publishing

bcdaa03

Merge branch 'master' into convert_to_multiplatform

fc7b32f

pass 'version' system property to gradle when publishing

fdc76c3

Merge remote-tracking branch 'origin/convert_to_multiplatform' into c…

96c9eff

…onvert_to_multiplatform # Conflicts: # .github/workflows/release.yml

fix names of workflows

791fa95

fullkomnun mentioned this pull request Feb 15, 2021

Use multiplatform big numbers komputing/KEthereum#96

Draft

ligi requested changes Feb 15, 2021

View reviewed changes

fullkomnun added 2 commits February 19, 2021 23:39

update gradle v6.8.1 -> v6.8.2

645c02d

update README.md

aa091af

fullkomnun marked this pull request as ready for review February 21, 2021 00:39

fullkomnun requested a review from ligi February 21, 2021 00:39

ligi approved these changes Feb 21, 2021

View reviewed changes

ligi merged commit a29443c into komputing:master Feb 21, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert to multiplatform #11

Convert to multiplatform #11

fullkomnun commented Jan 14, 2021 •

edited

ligi left a comment

fullkomnun commented Jan 16, 2021

ligi commented Jan 16, 2021

fullkomnun commented Jan 16, 2021

fullkomnun commented Jan 25, 2021 •

edited

ligi commented Jan 25, 2021

fullkomnun commented Jan 25, 2021

ligi commented Jan 25, 2021

fullkomnun commented Jan 25, 2021

ligi commented Jan 25, 2021

fullkomnun commented Jan 31, 2021

ligi commented Jan 31, 2021

fullkomnun commented Feb 8, 2021

ligi left a comment

ligi Feb 15, 2021

fullkomnun Feb 21, 2021

ligi Feb 15, 2021

fullkomnun Feb 21, 2021

ligi Feb 15, 2021

fullkomnun Feb 21, 2021

ligi commented Feb 16, 2021

ligi commented Feb 19, 2021

fullkomnun commented Feb 21, 2021

ligi commented Feb 21, 2021

fullkomnun commented Feb 21, 2021

ligi commented Feb 21, 2021

fullkomnun commented Feb 21, 2021

ligi commented Feb 21, 2021

		@@ -1,16 +1,46 @@
		![CI](https://github.com/fullkomnun/KHex/workflows/Continuous%20Integration/badge.svg)

	![CI](https://github.com/fullkomnun/KHex/workflows/Continuous%20Integration/badge.svg)
	![CI](https://github.com/komputing/KHex/workflows/Continuous%20Integration/badge.svg)

	name = "fullkomnun/KHex GitHub Packages"
	name = "komputing/KHex GitHub Packages"

	url = uri("https://maven.pkg.github.com/fullkomnun/KHex")
	url = uri("https://maven.pkg.github.com/komputing/KHex")

Convert to multiplatform #11

Convert to multiplatform #11

Conversation

fullkomnun commented Jan 14, 2021 • edited

ligi left a comment

Choose a reason for hiding this comment

fullkomnun commented Jan 16, 2021

ligi commented Jan 16, 2021

fullkomnun commented Jan 16, 2021

fullkomnun commented Jan 25, 2021 • edited

ligi commented Jan 25, 2021

fullkomnun commented Jan 25, 2021

ligi commented Jan 25, 2021

fullkomnun commented Jan 25, 2021

ligi commented Jan 25, 2021

fullkomnun commented Jan 31, 2021

ligi commented Jan 31, 2021

fullkomnun commented Feb 8, 2021

ligi left a comment

Choose a reason for hiding this comment

ligi Feb 15, 2021

Choose a reason for hiding this comment

fullkomnun Feb 21, 2021

Choose a reason for hiding this comment

ligi Feb 15, 2021

Choose a reason for hiding this comment

fullkomnun Feb 21, 2021

Choose a reason for hiding this comment

ligi Feb 15, 2021

Choose a reason for hiding this comment

fullkomnun Feb 21, 2021

Choose a reason for hiding this comment

ligi commented Feb 16, 2021

ligi commented Feb 19, 2021

fullkomnun commented Feb 21, 2021

ligi commented Feb 21, 2021

fullkomnun commented Feb 21, 2021

ligi commented Feb 21, 2021

fullkomnun commented Feb 21, 2021

ligi commented Feb 21, 2021

fullkomnun commented Jan 14, 2021 •

edited

fullkomnun commented Jan 25, 2021 •

edited