8000 :sparkles: Added `generate-resources` CLI command by pushrbx · Pull Request #647 · keycloakify/keycloakify · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

✨ Added generate-resources CLI command #647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

✨ Added generate-resources CLI command #647

wants to merge 1 commit into from

Conversation

pushrbx
Copy link
@pushrbx pushrbx commented Sep 11, 2024

This is a feature request I believe.
I have a bigger repo of extensions for keycloak, but written in kotlin and instead of maven, gradle is the build system. I'd like to add themes to my repo, and keycloakify seems to be a good fit. However it would feel strange to use maven next to gradle through keycloakify in said repo.
I've figured that if I just make the keycloakify cli to just generate the resources, I can create my own gradle script to pick those up and build a jar file, instead of relying on keycloakify cli to do that for me through maven.

Just for reference my gradle script looks like this:

import java.nio.file.Files
import kotlin.io.path.Path
import org.siouan.frontendgradleplugin.infrastructure.gradle.InstallFrontendTask

plugins {
    kotlin("jvm") version "2.0.20"
    id("com.gradleup.shadow") version "8.3.0"
    id("org.siouan.frontend-jdk21") version "8.1.0"
    id("java")
}

group = "org.pushrbx"
version = "1.0-SNAPSHOT"
val jarBaseName = "org.pushrbx.keycloak-themes"

repositories {
    mavenCentral()
}

dependencies {
    testImplementation(kotlin("test"))
    implementation("org.keycloak", "keycloak-client-registration-api", "25.0.4")
    implementation("dev.jcputney", "keycloak-theme-additional-info-extension", "1.1.5")
    implementation("io.phasetwo.keycloak", "keycloak-account-v1", "0.6")
}

tasks.test {
    useJUnitPlatform()
}

kotlin {
    jvmToolchain(17)
}

java {
    toolchain {
        languageVersion.set(JavaLanguageVersion.of(17))
    }
}

tasks.withType<JavaCompile> {
    options.release.set(17) // Ensure Java compatibility with 17
}

frontend {
    nodeVersion.set("22.6.0")
    nodeInstallDirectory.set(project.layout.projectDirectory.dir(".node"))
    installScript.set("install")
    assembleScript.set("run build")
    cleanScript.set("run clean")
}

tasks {
    val themeFiles by named<InstallFrontendTask>("installFrontend") {
        val ciPlatformPresent = providers.environmentVariable("CI").isPresent()
        val lockFilePath = "${projectDir}/package-lock.json"
        val retainedMetadataFileNames: Set<String>
        if (ciPlatformPresent) {
            retainedMetadataFileNames = setOf(lockFilePath)
        } else {
            val acceptableMetadataFileNames = listOf(lockFilePath, "${projectDir}/yarn.lock")
            retainedMetadataFileNames = mutableSetOf("${projectDir}/package.json")
            for (acceptableMetadataFileName in acceptableMetadataFileNames) {
                if (Files.exists(Path(acceptableMetadataFileName))) {
                    retainedMetadataFileNames.add(acceptableMetadataFileName)
                    break
                }
            }
            outputs.file(lockFilePath).withPropertyName("lockFile")
        }

        inputs.files(retainedMetadataFileNames).withPropertyName("metadataFiles")
        outputs.dir("${projectDir}/node_modules").withPropertyName("nodeModulesDirectory")
    }

    build {
        dependsOn(themeFiles)
    }

    assemble {
        dependsOn(themeFiles)
    }

    jar {
        archiveBaseName = jarBaseName
        manifest {
            attributes["Build-Jdk-Spec"] = "21"
        }
    }

    shadowJar {
        dependencies {
            include(dependency("dev.jcputney:keycloak-theme-additional-info-extension:1.1.5"))
            include(dependency("io.phasetwo.keycloak:keycloak-account-v1:0.6"))
        }
        archiveBaseName = jarBaseName
        dependsOn(build)
    }
}

siouan.frontendgradleplugin plugin installs nodejs, and installs the packages, then runs scripts from the package.json during a gradle build.
shadowjar is the equivalent of shade in the pom.xml generated by keycloakify.

In order to let gradle know about the generated resources by keycloakify, my build script in package.json calls this new command and copies the generated files:

tsc && vite build && keycloakify generate-resources && cp -r ./dist_keycloak/resources/theme ./src/main/resources/

This would make keycloakify compatible with any other build system outside maven.

@garronej
Copy link
Collaborator

Thank you for the PR. This is intresting.

A few think to note (for you):

implementation("dev.jcputney", "keycloak-theme-additional-info-extension", "1.1.5")

This dependency will no longer be required in Keycloak 26. We got this PR merged.

implementation("dev.jcputney", "keycloak-theme-additional-info-extension", "1.1.5")

This is only nessesary if you're impelementing a Multi-Page account theme.

@chenhunghan chenhunghan mentioned this pull request Oct 9, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@pushrbx @garronej
0