Split projects, migrate to Kotlin DSL #33

vlsi · 2020-02-15T17:02:18Z

The following changes happen here:

darklaf-windows is extracted to its own project. That helps to confine Windows-specific code
darklaf-native-utils is extracted to its own project as well so darklaf-windows and core can depend on it
build scripts are migrated to java-library
cpp-library does not work with java-library , so compileOnly+runtimeOnly is used instead of api/implementation.
build scripts are migrated to Kotlin DSL

Note: I think it makes sense to move core into its own subfolder (e.g. core), however, that change is not included here.
It would co-locate folders like core/src/ and core/build.

vlsi · 2020-02-16T10:52:19Z

@weisJ , I don't have a Windows machine with C++ toolchain installed.

Can you please check if darklaf-windows module builds ok?
I expect it should build both x86 and x86-64 libraries (if both toolchains are available).

In other words: ./gradlew :darklaf-windows:build, then check windows/build/libs/darklaf-...jar for dlls.

weisJ · 2020-02-16T11:55:21Z

Yes the module is build correctly.

vlsi · 2020-02-16T14:07:02Z

I guess the PR is more or less ready.

Release to Central should work.

If you have Docker, you can test the release with https://github.com/vlsi/asflike-release-environment#switching-tlps

The doc is here: https://github.com/vlsi/vlsi-release-plugins/tree/master/plugins/stage-vote-release-plugin#making-a-release-candidate

Basically:

./gradlew prepareVote -Prc=1 -Pgh. -Pgh stands for "push to GitHub and Central". If you omit -Pgh, it will push to localhost (~asflike-...)
It would create and populate staging repository in Nexus, so you would be able to review it and even drop it.
./gradlew publishDist -Prc=1 -Pgh would release the staging repository.

vlsi · 2020-02-16T16:21:53Z

At which point does signing of binaries happen?

You can add --dry-run (or -m) to see the approximate order of the tasks.

Also could you explain what properties I need to set in my own gradle.properties file?

https://github.com/vlsi/vlsi-release-plugins/tree/master/plugins/stage-vote-release-plugin#recommended-configuration

However please use gh prefix instead of asf.
I guess it should print the list of missing properties at the very start of prepareVote.

And prepareVote is the only step that needs signing keys (it signs artifacts and pushes them to the staging repository). The release task does not need signing.

because it has no configured signatory

Oh. It looks like it can't find a keyring file.

I have the following in my ~/.gradle/gradle.properties

signing.gnupg.keyName=AC2AEE0F
signing.keyId=AC2AEE0F
signing.password=
signing.secretKeyRingFile=/Users/vladimirsitnikov/.gnupg/secring.gpg
ghTestGitSourceUsername=
ghTestGitSourcePassword=
ghTestNexusUsername=
ghTestNexusPassword=
ghGitSourceUsername=
ghGitSourcePassword=
ghNexusUsername=
ghNexusPassword=

vlsi · 2020-02-16T16:28:46Z

build.gradle.kts

+
+val buildVersion = "darklaf".v + releaseParams.snapshotSuffix
+println("Building Darklaf $buildVersion")
+println("             OS: " + System.getProperty("os.name"))


I'm inclined to remove this as the user often knows which OS they are using.

Can be removed, no problem :)

weisJ · 2020-02-16T17:18:20Z

Ok great that worked. Thank you!
Though is it intended that debug binaries are also released?
https://oss.sonatype.org/content/repositories/comgithubweisj-1035/com/github/weisj/

Also a separate repository was created that is empty. Is this something that can be avoided? (If not it's not a big deal.)

How exactly does the voting process work? I'm still pretty new to this kind of stuff.

weisJ · 2020-02-16T17:35:42Z

build.gradle.kts

+            filteringCharset = "UTF-8"
+            textFrom("licenses/NOTICE.txt")
+            textFrom("licenses/PBJAR_LICENSE.txt")
+            textFrom("licenses/INTELLIJ_LICENSE.txt")


textFrom("licenses/DARCULA_LICENSE.txt") is missing here.

weisJ · 2020-02-16T17:52:20Z

Note: I think it makes sense to move core into its own subfolder (e.g. core), however, that change is not included here.
It would co-locate folders like core/src/ and core/build.

This would mean the parent project just adds darklaf-core as it's dependency and acts as a bundle for the components?

Edit: Forgot to mention that I do like the idea :)

vlsi · 2020-02-16T18:11:52Z

Though is it intended that debug binaries are also released?
https://oss.sonatype.org/content/repositories/comgithubweisj-1035/com/github/weisj/

Well, that was not intended. I don't think it makes sense to release .dll as a separate artifacts to Central.

My intention was to package lib and dll (is just a dll enough?) into darlaf-windows.jar.

However, in practice https://oss.sonatype.org/content/repositories/comgithubweisj-1035/com/github/weisj/darklaf-windows/1.3.3.4/darklaf-windows-1.3.3.4.jar includes windows-x86/darklaf-windows.lib twice.

Note: I think it is worth shipping debug libraries for the following reasons:

Performance is not that important
Debug would help in case of failure (e.g. core dump, etc, etc)

However, I thought I disabled publications of the individual dlls.

How exactly does the voting process work? I'm still pretty new to this kind of stuff.

It does not have to be a formal vote, however in Apache Software Foundation they have a requirement that each release have to pass a vote. That is release manager prepares the release artifacts, then other committers verify the artifacts and express their opinions.

It is like you shared a staging repository above. Now we know that the build script publishes a little bit too many files, and the contents of darklaf-windows.jar is not good.

vlsi · 2020-02-16T18:14:59Z

This would mean the parent project just adds darklaf-core as it's dependency and acts as a bundle for the components?

The root project does not have to add darklaf-core as a dependency.
The root would enforce the common configuration.

Edit: Forgot to mention that I do like the idea :)

Ok, cool. I suggest splitting the core to its own subfolder after this PR is merged.
Otherwise, the PR diff would be hard to see in GitHub UI (it will be full of trivial renames).

weisJ · 2020-02-16T18:28:47Z

My intention was to package lib and dll (is just a dll enough?) into darlaf-windows.jar.

The dll should be enough as that is the one that is being loaded.

However, in practice https://oss.sonatype.org/content/repositories/comgithubweisj-1035/com/github/weisj/darklaf-windows/1.3.3.4/darklaf-windows-1.3.3.4.jar includes windows-x86/darklaf-windows.lib twice.

So instead of the lib twice the dll should be included.

It is like you shared a staging repository above. Now we know that the build script publishes a little bit too many files, and the contents of darklaf-windows.jar is not good.

Ok thank you for the clarification.

The root project does not have to add darklaf-core as a dependency.

After testing it, it seems as if darklaf-core is needed when building the fat jar.

vlsi · 2020-02-16T18:41:09Z

building the fat jar.

What do you intend to use a fat jar for?

Fat jars do not play well with licensing: you have to obey the licenses for third parties you bundle.

vlsi · 2020-02-16T18:45:05Z

@weisJ , could you share ./gradlew prepareVote -Prc=1 --dry-run output?

weisJ · 2020-02-16T19:00:21Z

19:58:49: Executing task 'prepareVote --project-prop rc=1 --dry-run'...

> Task :buildSrc:extractPrecompiledScriptPluginPlugins UP-TO-DATE
> Task :buildSrc:generateExternalPluginSpecBuilders UP-TO-DATE
> Task :buildSrc:compilePluginsBlocks UP-TO-DATE
> Task :buildSrc:generatePrecompiledScriptPluginAccessors UP-TO-DATE
> Task :buildSrc:configurePrecompiledScriptDependenciesResolver
> Task :buildSrc:generateScriptPluginAdapters UP-TO-DATE
> Task :buildSrc:compileKotlin UP-TO-DATE
> Task :buildSrc:compileJava NO-SOURCE
> Task :buildSrc:compileGroovy NO-SOURCE
> Task :buildSrc:pluginDescriptors UP-TO-DATE
> Task :buildSrc:processResources UP-TO-DATE
> Task :buildSrc:classes UP-TO-DATE
> Task :buildSrc:inspectClassesForKotlinIC UP-TO-DATE
> Task :buildSrc:jar UP-TO-DATE
> Task :buildSrc:assemble UP-TO-DATE
> Task :buildSrc:compileTestKotlin NO-SOURCE
> Task :buildSrc:pluginUnderTestMetadata UP-TO-DATE
> Task :buildSrc:compileTestJava NO-SOURCE
> Task :buildSrc:compileTestGroovy NO-SOURCE
> Task :buildSrc:processTestResources NO-SOURCE
> Task :buildSrc:testClasses UP-TO-DATE
> Task :buildSrc:test NO-SOURCE
> Task :buildSrc:validatePlugins UP-TO-DATE
> Task :buildSrc:check UP-TO-DATE
> Task :buildSrc:build UP-TO-DATE

> Configure project :
Building Darklaf 1.3.3.4
             OS: Windows 10
            JDK: C:\Program Files\Java\java-1.8.0-openjdk-1.8.0.242-1.b08.ojdkbuild.windows.x86_64\jre
:validateBeforeBuildingReleaseArtifacts SKIPPED
:preparePreviewSiteRepo SKIPPED
:syncPreviewSiteRepo SKIPPED
:pushPreviewSite SKIPPED
:darklaf-native-utils:compileJava SKIPPED
:darklaf-windows:compileJava SKIPPED
:compileJava SKIPPED
:processResources SKIPPED
:classes SKIPPED
:jar SKIPPED
:javadoc SKIPPED
:javadocJar SKIPPED
:sourcesJar SKIPPED
:generateMetadataFileForDarklafPublication SKIPPED
:generatePomFileForDarklafPublication SKIPPED
:validateNexusCredentials SKIPPED
:initializeNexusStagingRepository SKIPPED
:signDarklafPublication SKIPPED
:publishDarklafPublicationToNexusRepository SKIPPED
:publish SKIPPED
:darklaf-native-utils:processResources SKIPPED
:darklaf-native-utils:classes SKIPPED
:darklaf-native-utils:jar SKIPPED
:darklaf-native-utils:javadoc SKIPPED
:darklaf-native-utils:javadocJar SKIPPED
:darklaf-native-utils:sourcesJar SKIPPED
:darklaf-native-utils:generateMetadataFileForDarklaf-native-utilsPublication SKIPPED
:darklaf-native-utils:generatePomFileForDarklaf-native-utilsPublication SKIPPED
:darklaf-native-utils:initializeNexusStagingRepository SKIPPED
:darklaf-native-utils:signDarklaf-native-utilsPublication SKIPPED
:darklaf-native-utils:publishDarklaf-native-utilsPublicationToNexusRepository SKIPPED
:darklaf-native-utils:publish SKIPPED
:darklaf-windows:processResources SKIPPED
:darklaf-windows:classes SKIPPED
:darklaf-windows:compileDebugX86Cpp SKIPPED
:darklaf-windows:linkDebugX86 SKIPPED
:darklaf-windows:compileDebugX86-64Cpp SKIPPED
:darklaf-windows:linkDebugX86-64 SKIPPED
:darklaf-windows:compileReleaseX86Cpp SKIPPED
:darklaf-windows:linkReleaseX86 SKIPPED
:darklaf-windows:compileReleaseX86-64Cpp SKIPPED
:darklaf-windows:linkReleaseX86-64 SKIPPED
:darklaf-windows:jar SKIPPED
:darklaf-windows:javadoc SKIPPED
:darklaf-windows:javadocJar SKIPPED
:darklaf-windows:sourcesJar SKIPPED
:darklaf-windows:generateMetadataFileForDarklaf-windowsPublication SKIPPED
:darklaf-windows:generatePomFileForDarklaf-windowsPublication SKIPPED
:darklaf-windows:initializeNexusStagingRepository SKIPPED
:darklaf-windows:signDarklaf-windowsPublication SKIPPED
:darklaf-windows:publishDarklaf-windowsPublicationToNexusRepository SKIPPED
:darklaf-windows:generateMetadataFileForMainDebugX86-64Publication SKIPPED
:darklaf-windows:generatePomFileForMainDebugX86-64Publication SKIPPED
:darklaf-windows:signMainDebugX86-64Publication SKIPPED
:darklaf-windows:publishMainDebugX86-64PublicationToNexusRepository SKIPPED
:darklaf-windows:generateMetadataFileForMainDebugX86Publication SKIPPED
:darklaf-windows:generatePomFileForMainDebugX86Publication SKIPPED
:darklaf-windows:signMainDebugX86Publication SKIPPED
:darklaf-windows:publishMainDebugX86PublicationToNexusRepository SKIPPED
:darklaf-windows:cppHeaders SKIPPED
:darklaf-windows:generateMetadataFileForMainPublication SKIPPED
:darklaf-windows:generatePomFileForMainPublication SKIPPED
:darklaf-windows:signMainPublication SKIPPED
:darklaf-windows:publishMainPublicationToNexusRepository SKIPPED
:darklaf-windows:generateMetadataFileForMainReleaseX86-64Publication SKIPPED
:darklaf-windows:generatePomFileForMainReleaseX86-64Publication SKIPPED
:darklaf-windows:signMainReleaseX86-64Publication SKIPPED
:darklaf-windows:publishMainReleaseX86-64PublicationToNexusRepository SKIPPED
:darklaf-windows:generateMetadataFileForMainReleaseX86Publication SKIPPED
:darklaf-windows:generatePomFileForMainReleaseX86Publication SKIPPED
:darklaf-windows:signMainReleaseX86Publication SKIPPED
:darklaf-windows:publishMainReleaseX86PublicationToNexusRepository SKIPPED
:darklaf-windows:publish SKIPPED
:closeRepository SKIPPED
:validateRcIndexSpecified SKIPPED
:validateSvnCredentials SKIPPED
:stageSvnDist SKIPPED
:createRcTag SKIPPED
:pushRcTag SKIPPED
:stageDist SKIPPED
:generateVoteText SKIPPED
:prepareVote SKIPPED

BUILD SUCCESSFUL in 8s
19:58:58: Task execution finished 'prepareVote --project-prop rc=1 --dry-run'.

weisJ · 2020-02-16T19:01:09Z

building the fat jar.

What do you intend to use a fat jar for?

Fat jars do not play well with licensing: you have to obey the licenses for third parties you bundle.

You are probably right with this. In this case the shadow plugin isn't needed anymore.

weisJ · 2020-02-16T19:26:04Z

I think the problem is with:
filter { it.isDebuggable }, as also the release versions return true for it.
It may be worth changing the filter to it.isOptimized.(As an alternative one could filter by it.name.contains("Debug")).
Also going from

from(binary.linkFile)

to

from(binary.linkFile
    .map { it.asFile }
    .map { it.parentFile.toPath().resolve( "${it.nameWithoutExtension}.dll") })
}
from(path)

copies the dll instead of the lib file.

Edit: Yes this resolves it. https://oss.sonatype.org/content/repositories/comgithubweisj-1036/com/github/weisj/darklaf-windows/1.3.3.4/darklaf-windows-1.3.3.4.jar

vlsi · 2020-02-16T20:10:43Z

it.isOptimized

Can you please try { it.isDebuggable && it.isOptimized }

Also going from from(binary.linkFile) to

Can you please try from(binary.runtimeFile) ?

weisJ · 2020-02-16T20:18:23Z

@vlsi working

weisJ · 2020-02-16T20:30:24Z

Does this conclude the PR?

vlsi · 2020-02-16T20:32:11Z

Does this conclude this PR?

Not yet.
As far as I see, binary.runtimeFile is the same as binary.linkFile :(

Does binary.runtimeFile return a name of .dll for you?

vlsi · 2020-02-16T20:33:39Z

Just in case: can you please perform yet another ./gradlew prepareVote -Prc=2 -Pgh so we doublecheck that individual dlls are not published anymore?

weisJ · 2020-02-16T20:45:06Z

binary.runtimeFile does return a .dll for me. Here is the new rc https://oss.sonatype.org/content/repositories/comgithubweisj-1038/

vlsi · 2020-02-16T20:47:39Z

Ok, great. rc2 looks wonderful to me.
I'm not sure windows lib works, but it can be fixed later if it does not :)

vlsi · 2020-02-16T20:59:11Z

One more thing: the missing bit is copying of the generated-pom.xml to their respective locations.
Do you need that?

vlsi force-pushed the refactor_build branch 25 times, most recently from f0958f6 to 838c6c8 Compare February 16, 2020 10:43

vlsi force-pushed the refactor_build branch 2 times, most recently from 96e0dd5 to 1826855 Compare February 16, 2020 13:57

vlsi force-pushed the refactor_build branch from 1826855 to 5317f9b Compare February 16, 2020 16:26

vlsi commented Feb 16, 2020

View reviewed changes

weisJ reviewed Feb 16, 2020

View reviewed changes

vlsi force-pushed the refactor_build branch from 5317f9b to d9a9df2 Compare February 16, 2020 20:16

Split projects, migrate to Kotlin DSL

3ae99e4

vlsi force-pushed the refactor_build branch from d9a9df2 to 3ae99e4 Compare February 16, 2020 20:19

vlsi changed the title ~~WIP: split projects, migrate to Kotlin DSL~~ Split projects, migrate to Kotlin DSL Feb 16, 2020

weisJ merged commit 74ad3a6 into weisJ:master Feb 16, 2020

This was referenced Feb 16, 2020

What do you think of kotlin DSL for Gradle scripts? #28

Closed

Please include LICENSE and NOTICE to the artifact jar #22

Closed

weisJ linked an issue Feb 16, 2020 that may be closed by this pull request

What do you think of kotlin DSL for Gradle scripts? #28

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split projects, migrate to Kotlin DSL #33

Split projects, migrate to Kotlin DSL #33

vlsi commented Feb 15, 2020 •

edited

Loading

vlsi commented Feb 16, 2020

weisJ commented Feb 16, 2020

vlsi commented Feb 16, 2020

vlsi commented Feb 16, 2020 •

edited

Loading

vlsi Feb 16, 2020

weisJ Feb 16, 2020

weisJ commented Feb 16, 2020

weisJ Feb 16, 2020

weisJ commented Feb 16, 2020 •

edited

Loading

vlsi commented Feb 16, 2020

vlsi commented Feb 16, 2020

weisJ commented Feb 16, 2020 •

edited

Loading

vlsi commented Feb 16, 2020

vlsi commented Feb 16, 2020

weisJ commented Feb 16, 2020

weisJ commented Feb 16, 2020

weisJ commented Feb 16, 2020 •

edited

Loading

vlsi commented Feb 16, 2020

weisJ commented Feb 16, 2020

weisJ commented Feb 16, 2020 •

edited

Loading

vlsi commented Feb 16, 2020

vlsi commented Feb 16, 2020

weisJ commented Feb 16, 2020

vlsi commented Feb 16, 2020

vlsi commented Feb 16, 2020

Split projects, migrate to Kotlin DSL #33

Split projects, migrate to Kotlin DSL #33

Conversation

vlsi commented Feb 15, 2020 • edited Loading

vlsi commented Feb 16, 2020

weisJ commented Feb 16, 2020

vlsi commented Feb 16, 2020

vlsi commented Feb 16, 2020 • edited Loading

vlsi Feb 16, 2020

Choose a reason for hiding this comment

weisJ Feb 16, 2020

Choose a reason for hiding this comment

weisJ commented Feb 16, 2020

weisJ Feb 16, 2020

Choose a reason for hiding this comment

weisJ commented Feb 16, 2020 • edited Loading

vlsi commented Feb 16, 2020

vlsi commented Feb 16, 2020

weisJ commented Feb 16, 2020 • edited Loading

vlsi commented Feb 16, 2020

vlsi commented Feb 16, 2020

weisJ commented Feb 16, 2020

weisJ commented Feb 16, 2020

weisJ commented Feb 16, 2020 • edited Loading

vlsi commented Feb 16, 2020

weisJ commented Feb 16, 2020

weisJ commented Feb 16, 2020 • edited Loading

vlsi commented Feb 16, 2020

vlsi commented Feb 16, 2020

weisJ commented Feb 16, 2020

vlsi commented Feb 16, 2020

vlsi commented Feb 16, 2020

vlsi commented Feb 15, 2020 •

edited

Loading

vlsi commented Feb 16, 2020 •

edited

Loading

weisJ commented Feb 16, 2020 •

edited

Loading

weisJ commented Feb 16, 2020 •

edited

Loading

weisJ commented Feb 16, 2020 •

edited

Loading

weisJ commented Feb 16, 2020 •

edited

Loading