Pull release notes from keycloak-client repository

Closes #547

Signed-off-by: Jon Koops <[email protected]>
Signed-off-by: Marek Posolda <[email protected]>
Co-authored-by: Marek Posolda <[email protected]>

add-version-client.sh

@@ -0,0 +1,29 @@
+#!/bin/bash -e
+
+VERSION=$1
+if [ "$VERSION" == "" ]; then
+    echo "usage: add-version-client.sh VERSION"
+    exit 1
+fi
+
+VERSION_NAME=`echo $VERSION | sed 's/.Final//' | sed 's/.CR[[:digit:]]//'`
+DATE=`date +%F`
+
+if [[ "$VERSION" == *".0" ]]; then
+    TEMPLATE="version-template-client.json"
+else
+    TEMPLATE="versions/keycloak-client/${VERSION%.*}.0.json"
+fi
+
+if [ ! -f "$TEMPLATE" ]; then
+    echo "$TEMPLATE not found"
+    exit
+fi
+
+cat $TEMPLATE | sed "s/\"version\":.*/\"version\": \"$VERSION\",/" | sed 's/"date": ".*"/"date": "DATE"/' | sed "s/DATE/$DATE/" > versions/keycloak-client/$VERSION_NAME.json
+
+CURRENT=`cat pom.xml | grep '<version.keycloak.client>' | cut -d '>' -f 2 | cut -d '<' -f 1`
+LATEST=`echo -e "$CURRENT\n$VERSION" | sort -V -r | head -n 1`
+
+mvn versions:set-property -Dproperty=version.keycloak.client -DnewVersion=$LATEST -DgenerateBackupPoms=false
+mvn install

add-version.sh

@@ -9,22 +9,21 @@ fi
 VERSION_NAME=`echo $VERSION | sed 's/.Final//' | sed 's/.CR[[:digit:]]//'`
 DATE=`date +%F`
 
-if [[ "$VERSION" == *".0" ]]; then 
+if [[ "$VERSION" == *".0" ]]; then
     TEMPLATE="version-template.json"
 else
-    TEMPLATE="versions/${VERSION%.*}.0.json"
+    TEMPLATE="versions/keycloak/${VERSION%.*}.0.json"
 fi
 
 if [ ! -f "$TEMPLATE" ]; then
     echo "$TEMPLATE not found"
     exit
 fi
 
-cat $TEMPLATE | sed "s/\"version\":.*/\"version\": \"$VERSION\",/" | sed 's/"date": ".*"/"date": "DATE"/' | sed "s/DATE/$DATE/" > versions/$VERSION_NAME.json
+cat $TEMPLATE | sed "s/\"version\":.*/\"version\": \"$VERSION\",/" | sed 's/"date": ".*"/"date": "DATE"/' | sed "s/DATE/$DATE/" > versions/keycloak/$VERSION_NAME.json
 
 CURRENT=`cat pom.xml | grep '<version.keycloak>' | cut -d '>' -f 2 | cut -d '<' -f 1`
 LATEST=`echo -e "$CURRENT\n$VERSION" | sort -V -r | head -n 1`
 
-sed -i "s|<version.keycloak>$CURRENT</version.keycloak>|<version.keycloak>$LATEST</version.keycloak>|g" pom.xml
-
+mvn versions:set-property -Dproperty=version.keycloak -DnewVersion=$LATEST -DgenerateBackupPoms=false
 mvn install

cache/releases/keycloak-client/26.0.0/gh-release-notes.html

@@ -0,0 +1,38 @@
+<div>
+    <h2>Highlights</h2>
+<div class="sect2">
+<h3 id="_dedicated_release_cycle_for_the_client_libraries">Dedicated release cycle for the client libraries</h3>
+<div class="paragraph">
+<p>From this release, some of the Keycloak client libraries will have release cycle independent of the Keycloak server release cycle. The 26.0.0 release may be the last one
+when the client libraries are released together with the Keycloak server. But from now on, the client libraries may be released at a different time than the Keycloak server.</p>
+</div>
+<div class="paragraph">
+<p>The client libraries are these artifacts:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Java admin client - Maven artifact <code>org.keycloak:keycloak-admin-client</code></p>
+</li>
+<li>
+<p>Java authorization client - Maven artifact <code>org.keycloak:keycloak-authz-client</code></p>
+</li>
+<li>
+<p>Java policy enforcer - Maven artifact <code>org.keycloak:keycloak-policy-enforcer</code></p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>It is possible that in the future, some more libraries will be included.</p>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_compatibility_of_the_client_libraries_with_the_server">Compatibility of the client libraries with the server</h3>
+<div class="paragraph">
+<p>Beginning with this release, we are testing and supporting client libraries with the same server version and a few previous major server versions.</p>
+</div>
+</div>
+<h2>Upgrading</h2>
+<p>Before upgrading refer to <a href="https://www.keycloak.org/securing-apps/upgrading">the migration guide</a> for a complete list of changes.</p>
+
+</div>

cache/releases/keycloak-client/26.0.0/release-notes.html

@@ -0,0 +1,32 @@
+<div class="sect2">
+<h3 id="_dedicated_release_cycle_for_the_client_libraries">Dedicated release cycle for the client libraries</h3>
+<div class="paragraph">
+<p>From this release, some of the Keycloak client libraries will have release cycle independent of the Keycloak server release cycle. The 26.0.0 release may be the last one
+when the client libraries are released together with the Keycloak server. But from now on, the client libraries may be released at a different time than the Keycloak server.</p>
+</div>
+<div class="paragraph">
+<p>The client libraries are these artifacts:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Java admin client - Maven artifact <code>org.keycloak:keycloak-admin-client</code></p>
+</li>
+<li>
+<p>Java authorization client - Maven artifact <code>org.keycloak:keycloak-authz-client</code></p>
+</li>
+<li>
+<p>Java policy enforcer - Maven artifact <code>org.keycloak:keycloak-policy-enforcer</code></p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>It is possible that in the future, some more libraries will be included.</p>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_compatibility_of_the_client_libraries_with_the_server">Compatibility of the client libraries with the server</h3>
+<div class="paragraph">
+<p>Beginning with this release, we are testing and supporting client libraries with the same server version and a few previous major server versions.</p>
+</div>
+</div>

cache/releases/keycloak-client/26.0.1/changelog.json

@@ -0,0 +1,15 @@
+[ {
+  "number" : 89,
+  "repository" : "keycloak-client",
+  "title" : "ClientTest failing with latest Keycloak nightly",
+  "kind" : "bug",
+  "area" : "admin-client",
+  "url" : "https://github.com/keycloak/keycloak-client/issues/89"
+}, {
+  "number" : 92,
+  "repository" : "keycloak-client",
+  "title" : "Setup CI during nightly build",
+  "kind" : "enhancement",
+  "area" : null,
+  "url" : "https://github.com/keycloak/keycloak-client/issues/92"
+} ]

cache/releases/keycloak-client/26.0.1/gh-release-notes.html

@@ -0,0 +1,20 @@
+<div>
+
+<h2>Upgrading</h2>
+<p>Before upgrading refer to <a href="https://www.keycloak.org/securing-apps/upgrading">the migration guide</a> for a complete list of changes.</p>
+
+<h2>All resolved issues</h2>
+
+
+
+<h3>Enhancements</h3>
+<ul>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/92">#92</a> Setup CI during nightly build </li>
+</ul>
+
+<h3>Bugs</h3>
+<ul>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/89">#89</a> ClientTest failing with latest Keycloak nightly <code>admin-client</code></li>
+</ul>
+
+</div>

cache/releases/keycloak-client/26.0.2/changelog.json

@@ -0,0 +1,22 @@
+[ {
+  "number" : 92,
+  "repository" : "keycloak-client",
+  "title" : "Setup CI during nightly build",
+  "kind" : "enhancement",
+  "area" : null,
+  "url" : "https://github.com/keycloak/keycloak-client/issues/92"
+}, {
+  "number" : 94,
+  "repository" : "keycloak-client",
+  "title" : "Tests failing with latest Keycloak server nightly",
+  "kind" : "bug",
+  "area" : null,
+  "url" : "https://github.com/keycloak/keycloak-client/issues/94"
+}, {
+  "number" : 99,
+  "repository" : "keycloak-client",
+  "title" : "Sync with keycloak server 26.0.4",
+  "kind" : "enhancement",
+  "area" : "admin-client",
+  "url" : "https://github.com/keycloak/keycloak-client/issues/99"
+} ]

cache/releases/keycloak-client/26.0.2/gh-release-notes.html

@@ -0,0 +1,21 @@
+<div>
+
+<h2>Upgrading</h2>
+<p>Before upgrading refer to <a href="https://www.keycloak.org/securing-apps/upgrading">the migration guide</a> for a complete list of changes.</p>
+
+<h2>All resolved issues</h2>
+
+
+
+<h3>Enhancements</h3>
+<ul>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/92">#92</a> Setup CI during nightly build </li>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/99">#99</a> Sync with keycloak server 26.0.4 <code>admin-client</code></li>
+</ul>
+
+<h3>Bugs</h3>
+<ul>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/94">#94</a> Tests failing with latest Keycloak server nightly </li>
+</ul>
+
+</div>

cache/releases/keycloak-client/26.0.3/changelog.json

@@ -0,0 +1,36 @@
+[ {
+  "number" : 87,
+  "repository" : "keycloak-client",
+  "title" : "Setup nightly action to sync from keycloak server main",
+  "kind" : "task",
+  "area" : null,
+  "url" : "https://github.com/keycloak/keycloak-client/issues/87"
+}, {
+  "number" : 90,
+  "repository" : "keycloak-client",
+  "title" : "Update MD files ",
+  "kind" : "enhancement",
+  "area" : null,
+  "url" : "https://github.com/keycloak/keycloak-client/issues/90"
+}, {
+  "number" : 93,
+  "repository" : "keycloak-client",
+  "title" : "Move upgrading guide for keycloak-client libraries to the client documentation",
+  "kind" : "enhancement",
+  "area" : "docs",
+  "url" : "https://github.com/keycloak/keycloak-client/issues/93"
+}, {
+  "number" : 101,
+  "repository" : "keycloak-client",
+  "title" : "Setup GH action (or script), which will send PR for automatically sync with keycloak server",
+  "kind" : "enhancement",
+  "area" : null,
+  "url" : "https://github.com/keycloak/keycloak-client/issues/101"
+}, {
+  "number" : 105,
+  "repository" : "keycloak-client",
+  "title" : "Unnecessary `httpclient` dependency in `keycloak-client-common-synced` module",
+  "kind" : "bug",
+  "area" : null,
+  "url" : "https://github.com/keycloak/keycloak-client/issues/105"
+} ]

cache/releases/keycloak-client/26.0.3/gh-release-notes.html

@@ -0,0 +1,22 @@
+<div>
+
+<h2>Upgrading</h2>
+<p>Before upgrading refer to <a href="https://www.keycloak.org/securing-apps/upgrading">the migration guide</a> for a complete list of changes.</p>
+
+<h2>All resolved issues</h2>
+
+
+
+<h3>Enhancements</h3>
+<ul>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/90">#90</a> Update MD files  </li>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/93">#93</a> Move upgrading guide for keycloak-client libraries to the client documentation <code>docs</code></li>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/101">#101</a> Setup GH action (or script), which will send PR for automatically sync with keycloak server </li>
+</ul>
+
+<h3>Bugs</h3>
+<ul>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/105">#105</a> Unnecessary `httpclient` dependency in `keycloak-client-common-synced` module </li>
+</ul>
+
+</div>

cache/releases/keycloak-client/26.0.4/changelog.json

@@ -0,0 +1,50 @@
+[ {
+  "number" : 113,
+  "repository" : "keycloak-client",
+  "title" : "Wrong logger class",
+  "kind" : "enhancement",
+  "area" : "policy-enforcer",
+  "url" : "https://github.com/keycloak/keycloak-client/issues/113"
+}, {
+  "number" : 115,
+  "repository" : "keycloak-client",
+  "title" : "ProviderTest failing with latest nightly build",
+  "kind" : "bug",
+  "area" : "testsuite",
+  "url" : "https://github.com/keycloak/keycloak-client/issues/115"
+}, {
+  "number" : 117,
+  "repository" : "keycloak-client",
+  "title" : "Remove JEE from the title of GH actions",
+  "kind" : "enhancement",
+  "area" : null,
+  "url" : "https://github.com/keycloak/keycloak-client/issues/117"
+}, {
+  "number" : 124,
+  "repository" : "keycloak-client",
+  "title" : "The action \"Sync with Keycloak Server and send PR with changes\" sends PR, which does not have DCO on the commit",
+  "kind" : "bug",
+  "area" : null,
+  "url" : "https://github.com/keycloak/keycloak-client/issues/124"
+}, {
+  "number" : 127,
+  "repository" : "keycloak-client",
+  "title" : "Sync after Keycloak server 26.1.0 release",
+  "kind" : "enhancement",
+  "area" : null,
+  "url" : "https://github.com/keycloak/keycloak-client/issues/127"
+}, {
+  "number" : 129,
+  "repository" : "keycloak-client",
+  "title" : "The action \"Sync with Keycloak Server and send PR with changes\" takes only client-common-synced into consideration",
+  "kind" : "bug",
+  "area" : null,
+  "url" : "https://github.com/keycloak/keycloak-client/issues/129"
+}, {
+  "number" : 130,
+  "repository" : "keycloak-client",
+  "title" : "Test with keycloak server images 24.0, 26.0 and 26.1",
+  "kind" : "enhancement",
+  "area" : "testsuite",
+  "url" : "https://github.com/keycloak/keycloak-client/issues/130"
+} ]

cache/releases/keycloak-client/26.0.4/gh-release-notes.html

@@ -0,0 +1,25 @@
+<div>
+
+<h2>Upgrading</h2>
+<p>Before upgrading refer to <a href="https://www.keycloak.org/securing-apps/upgrading">the migration guide</a> for a complete list of changes.</p>
+
+<h2>All resolved issues</h2>
+
+
+
+<h3>Enhancements</h3>
+<ul>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/113">#113</a> Wrong logger class <code>policy-enforcer</code></li>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/117">#117</a> Remove JEE from the title of GH actions </li>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/127">#127</a> Sync after Keycloak server 26.1.0 release </li>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/130">#130</a> Test with keycloak server images 24.0, 26.0 and 26.1 <code>testsuite</code></li>
+</ul>
+
+<h3>Bugs</h3>
+<ul>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/115">#115</a> ProviderTest failing with latest nightly build <code>testsuite</code></li>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/124">#124</a> The action "Sync with Keycloak Server and send PR with changes" sends PR, which does not have DCO on the commit </li>
+<li><a href="https://github.com/keycloak/keycloak-client/issues/129">#129</a> The action "Sync with Keycloak Server and send PR with changes" takes only client-common-synced into consideration </li>
+</ul>
+
+</div>

cache/releases/keycloak/24.0.1/changelog.json

@@ -0,0 +1 @@
+[ ]

releases.yaml

@@ -0,0 +1,15 @@
+sources:
+  - id: keycloak
+    productName: Keycloak
+    repo: keycloak/keycloak
+    githubReleaseNotesFrom: 23.0.0
+    releaseNotes: release/${version.getVersionShorter()}/docs/documentation/release_notes/topics/${version.getVersion()?replace(".", "_")}.adoc
+    attributeSources:
+      - release/${version.getVersionShorter()}/docs/documentation/topics/templates/document-attributes.adoc
+      - ${version.getVersion()}/docs/documentation/topics/templates/document-attributes.adoc
+    migrationGuidePath: docs/latest/upgrading/index.html#migration-changes
+  - id: keycloak-client
+    productName: Keycloak Client Libraries
+    repo: keycloak/keycloak-client
+    releaseNotes: main/docs/release-notes/${version.getVersion()?replace(".", "_")}.adoc
+    migrationGuidePath: securing-apps/upgrading