From b8bf02c1a6096c4887c1bd5306a954643f715544 Mon Sep 17 00:00:00 2001 From: Motouom Victoire Date: Fri, 8 Nov 2024 10:51:45 +0100 Subject: [PATCH 1/3] Add navigation menu to the README --- CHANGELOG.md | 1 + README.md | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 03b86cd91..17ae39286 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +- improved logging for realm retrieval errors [#1010](https://github.com/adorsys/keycloak-config-cli/issues/1010) ### Added - improved logging for realm retrieval errors [#1010](https://github.com/adorsys/keycloak-config-cli/issues/1010) ### Fixed diff --git a/README.md b/README.md index f69688c84..5344a7596 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,29 @@ [![codecov](https://codecov.io/gh/adorsys/keycloak-config-cli/branch/main/graph/badge.svg)](https://codecov.io/gh/adorsys/keycloak-config-cli) [![GitHub license](https://img.shields.io/github/license/adorsys/keycloak-config-cli)](https://github.com/adorsys/keycloak-config-cli/blob/main/LICENSE.txt) +# Table of Contents + +- [Config Files](#config-files) +- [Variable Substitution](#variable-substitution) + - [Supported Substitutions](#supported-substitutions) +- [Logging](#logging) + - [JSON Logging Support](#json-logging-support) + - [Log Level](#log-level) +- [Supported Features](#supported-features) +- [Compatibility with Keycloak](#compatibility-with-keycloak) +- [Build this Project](#build-this-project) +- [Run Integration Tests](#run-integration-tests) +- [Run this Project](#run-this-project) +- [Docker](#docker) +- [Helm](#helm) +- [Configuration](#configuration) + - [CLI Options / Environment Variables](#cli-options--environment-variables) + - [Keycloak Options](#keycloak-options) + - [Import Options](#import-options) + - [Spring Boot Options](#spring-boot-options) +- [Perform Release](#perform-release) +- [Commercial Support](#commercial-support) + # keycloak-config-cli keycloak-config-cli is a Keycloak utility to ensure the desired configuration state for a realm based on a JSON/YAML file. The format of the JSON/YAML file based on the export realm format. Store and handle the configuration files inside git just like normal code. A Keycloak restart isn't required to apply the configuration. From 36b79f1ff2a3ce1206b0916b01749a68e3d3034e Mon Sep 17 00:00:00 2001 From: Motouom Victoire Date: Fri, 8 Nov 2024 11:17:02 +0100 Subject: [PATCH 2/3] Applied changes requested. --- README.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5344a7596..a7a60d7b7 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,7 @@ - [Config Files](#config-files) - [Variable Substitution](#variable-substitution) - - [Supported Substitutions](#supported-substitutions) - [Logging](#logging) - - [JSON Logging Support](#json-logging-support) - - [Log Level](#log-level) - [Supported Features](#supported-features) - [Compatibility with Keycloak](#compatibility-with-keycloak) - [Build this Project](#build-this-project) @@ -21,10 +18,6 @@ - [Docker](#docker) - [Helm](#helm) - [Configuration](#configuration) - - [CLI Options / Environment Variables](#cli-options--environment-variables) - - [Keycloak Options](#keycloak-options) - - [Import Options](#import-options) - - [Spring Boot Options](#spring-boot-options) - [Perform Release](#perform-release) - [Commercial Support](#commercial-support) @@ -114,6 +107,8 @@ Further development requirements - Java Development Kit (JDK) - Docker Desktop or an alternative replacement (e.g Rancher Desktop) +Before running `mvn verify`, you have to set the JAVA_HOME environment variable to prevent some test failures. + ```shell ./mvnw verify From e5b17a6c3e4365701567382be7eef0ebd11327ae Mon Sep 17 00:00:00 2001 From: Motouom Victoire Date: Fri, 8 Nov 2024 11:26:12 +0100 Subject: [PATCH 3/3] Update changelog --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 17ae39286..4e0cacd7f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,8 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] -- improved logging for realm retrieval errors [#1010](https://github.com/adorsys/keycloak-config-cli/issues/1010) +### Added +- Added Navigation in the readme [#1010](https://github.com/adorsys/keycloak-config-cli/issues/1010) ### Added - improved logging for realm retrieval errors [#1010](https://github.com/adorsys/keycloak-config-cli/issues/1010) ### Fixed