Add documentation

src/bin/build-keycloak-theme/generateDebugFiles/index.ts

@@ -2,6 +2,8 @@
 import * as fs from "fs";
 import { join as pathJoin, dirname as pathDirname, basename as pathBasename } from "path";
 
+export const containerLaunchScriptBasename = "start_keycloak_testing_container.sh";
+
 /** Files for being able to run a hot reload keycloak container */
 export function generateDebugFiles(
     params: {
@@ -34,7 +36,7 @@ export function generateDebugFiles(
     const containerName = "keycloak-testing-container";
 
     fs.writeFileSync(
-        pathJoin(keycloakThemeBuildingDirPath, "start_keycloak_testing_container.sh"),
+        pathJoin(keycloakThemeBuildingDirPath, containerLaunchScriptBasename),
         Buffer.from(
             [
                 "#!/bin/bash",

src/bin/build-keycloak-theme/generateJavaStackFiles.ts

@@ -14,7 +14,7 @@ export function generateJavaStackFiles(
         parsedPackageJson: ParsedPackageJson;
         keycloakThemeBuildingDirPath: string;
     }
-): void {
+): { jarFilePath: string; } {
 
     const {
         parsedPackageJson: { name, version, homepage },
@@ -94,5 +94,7 @@ export function generateJavaStackFiles(
 
     }
 
+    return { "jarFilePath": pathJoin(keycloakThemeBuildingDirPath, "target", `${name}-${version}.jar`) };
+
 }
 

src/bin/build-keycloak-theme/index.ts

@@ -3,9 +3,10 @@
 import { generateKeycloakThemeResources } from "./generateKeycloakThemeResources";
 import { generateJavaStackFiles } from "./generateJavaStackFiles";
 import type { ParsedPackageJson } from "./generateJavaStackFiles";
-import { join as pathJoin } from "path";
+import { join as pathJoin, relative as pathRelative, basename as pathBasename } from "path";
 import * as child_process from "child_process";
-import { generateDebugFiles } from "./generateDebugFiles";
+import { generateDebugFiles, containerLaunchScriptBasename } from "./generateDebugFiles";
+
 
 const reactProjectDirPath = process.cwd();
 
@@ -13,6 +14,9 @@ const parsedPackageJson: ParsedPackageJson = require(pathJoin(reactProjectDirPat
 
 export const keycloakThemeBuildingDirPath = pathJoin(reactProjectDirPath, "build_keycloak");
 
+
+console.log("🔏 Building the keycloak theme...⌚");
+
 if (require.main === module) {
 
     generateKeycloakThemeResources({
@@ -21,7 +25,7 @@ if (require.main === module) {
         "themeName": parsedPackageJson.name
     });
 
-    generateJavaStackFiles({
+    const { jarFilePath } = generateJavaStackFiles({
         parsedPackageJson,
         keycloakThemeBuildingDirPath
     });
@@ -36,4 +40,36 @@ if (require.main === module) {
         "packageJsonName": parsedPackageJson.name
     });
 
+    console.log([
+        '',
+        `✅ Your keycloak theme has been generated and bundled into ./${pathRelative(reactProjectDirPath, jarFilePath)} 🚀`,
+        `It is to be placed in "/opt/jboss/keycloak/standalone/deployments" in the container running a jboss/keycloak Docker image. (Tested with 11.0.3)`,
+        '',
+        'Using Helm (https://github.com/codecentric/helm-charts), edit to reflect:',
+        '',
+        'value.yaml: ',
+        '    extraInitContainers: |',
+        '        - name: realm-ext-provider',
+        '          image: curlimages/curl',
+        '          imagePullPolicy: IfNotPresent',
+        '          command:',
+        '            - sh',
+        '          args:',
+        '            - -c',
+        `            - curl -L -f -S -o /extensions/${pathBasename(jarFilePath)} https://AN.URL.FOR/${pathBasename(jarFilePath)}`,
+        '          volumeMounts:',
+        '            - name: extensions',
+        '              mountPath: /extensions',
+        '        ',
+        '        extraVolumeMounts: |',
+        '            - name: extensions',
+        '              mountPath: /opt/jboss/keycloak/standalone/deployments',
+        '',
+        `To enable the theme within keycloak log into the admin console, go to your realm settings, click on the theme tab then select ${parsedPackageJson.name} `,
+        '',
+        'To test your theme locally you can spin up a Keycloak container image with the theme loaded by running:',
+        '',
+        `$ ./${pathRelative(reactProjectDirPath, pathJoin(keycloakThemeBuildingDirPath, containerLaunchScriptBasename))}`
+    ].join("\n"));
+
 }