mirror of
https://github.com/apple/pkl.git
synced 2026-04-20 07:21:32 +02:00
b445713b8c
This adds logic to build and publish the other executables related to Pkl. These are: * pkl-doc * pkl-codegen-kotlin * pkl-codegen-java pkl-codegen-kotlin and pkl-codegen-java are published as executable JARs, whereas pkldoc is published both as an executable JAR, and also native executables (matching the set of os/arch supported by Pkl). The reason this only publishes executable JARs for pkl-codegen-kotlin and pkl-codegen-java is because we expect that the Java requirement is not a problem for these users, and that the native executable provides negligible added value. As part of this, the following changes are made: * Introduce `pklJavaExecutable` plugin, which sets up building and publishing of executable JAR. * Introduce `pklNativeExecutable` plugin, which sets up building and publishing of native executables. * Introduce `NativeImageBuild` Gradle task, which knows how to build native-image executables. * Introduce `ExecutableSpec` extension, for projects that publish executables to configure how those executables should be published. * `./griddles buildNative`, by default, will only build the executable of the host OS/Arch, and will no longer cross-build. * The target arch of `./gradlew buildNative` can be changed using `-Dpkl.targetArch=<aarch64|amd64>`. * On linux/amd64 only, with `./gradlew buildNative`, a statically linked executable can be built using `-Dpkl.musl=true` * Make `javaExecutable` a dependency of `assemble` * Make `testStartJavaExecutable` a dependency of `check` * Change name `pklNativeBuild` to `pklNativeLifecycle` to better match the plugin's purpose * Remove Truffle SVM classes from main source set (don't publish these classes as part of the pkl-cli JAR) * Change CircleCI definition to publish new executables * Change CircleCI definition to call `buildNative` instead of individual task names
72 lines
2.1 KiB
Kotlin
72 lines
2.1 KiB
Kotlin
/*
|
|
* Copyright © 2024-2025 Apple Inc. and the Pkl project authors. All rights reserved.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* https://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
plugins {
|
|
pklAllProjects
|
|
pklKotlinLibrary
|
|
pklJavaExecutable
|
|
pklNativeExecutable
|
|
pklHtmlValidator
|
|
alias(libs.plugins.kotlinxSerialization)
|
|
}
|
|
|
|
executable {
|
|
mainClass = "org.pkl.doc.Main"
|
|
name = "pkldoc"
|
|
javaName = "jpkldoc"
|
|
documentationName = "Pkldoc CLI"
|
|
publicationName = "pkldoc"
|
|
javaPublicationName = "jpkldoc"
|
|
website = "https://pkl-lang.org/main/current/pkl-doc/index.html"
|
|
}
|
|
|
|
dependencies {
|
|
implementation(projects.pklCore)
|
|
implementation(projects.pklCommonsCli)
|
|
implementation(projects.pklCommons)
|
|
implementation(projects.pklParser)
|
|
implementation(libs.commonMark)
|
|
implementation(libs.commonMarkTables)
|
|
implementation(libs.kotlinxHtml)
|
|
implementation(libs.kotlinxSerializationJson) {
|
|
// use our own Kotlin version
|
|
// (exclude is supported both for Maven and Gradle metadata, whereas dependency constraints
|
|
// aren't)
|
|
exclude(group = "org.jetbrains.kotlin")
|
|
}
|
|
|
|
testImplementation(projects.pklCommonsTest)
|
|
testImplementation(libs.jimfs)
|
|
|
|
// Graal.JS
|
|
testImplementation(libs.graalSdk)
|
|
testImplementation(libs.graalJs)
|
|
}
|
|
|
|
publishing {
|
|
publications {
|
|
named<MavenPublication>("library") {
|
|
pom {
|
|
url.set("https://github.com/apple/pkl/tree/main/pkl-doc")
|
|
description.set("Documentation generator for Pkl modules.")
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
tasks.jar { manifest { attributes += mapOf("Main-Class" to "org.pkl.doc.Main") } }
|
|
|
|
htmlValidator { sources = files("src/test/files/DocGeneratorTest/output") }
|