Skip to content

Backporting documentation PRs #23454

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

Merged
ahus1 merged 2 commits into from
Oct 6, 2023
Merged

Backporting documentation PRs #23454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b25a785
Prevent exception in the log (#22201)
ahus1 Sep 19, 2023
3ea0c3f
Ignoring link for stackapps registration (#23347)
ahus1 Sep 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 6 additions & 18 deletions .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,12 @@ jobs:
name: Maven cache
uses: ./.github/actions/maven-cache

- id: build-documentation
name: Build Keycloak
- id: build-test-documentation
name: Build and verify Keycloak documentation
shell: bash
run: |
MVN_HTTP_CONFIG="-Dhttp.keepAlive=false -Dmaven.wagon.http.pool=false -Dmaven.wagon.http.retryHandler.class=standard -Dmaven.wagon.http.retryHandler.count=3 -Dmaven.wagon.httpconnectionManager.ttlSeconds=120"
./mvnw install -DskipTests -am -pl docs/documentation/tests,docs/documentation/dist -nsu -B -e $MVN_HTTP_CONFIG -Pdocumentation

- id: test-documentation
name: Verify Keycloak documentation
shell: bash
run: |
./mvnw test -Dtest=!ExternalLinksTest -am -pl docs/documentation/tests,docs/documentation/dist -nsu -B -e -Pdocumentation
./mvnw install -Dtest=!ExternalLinksTest -am -pl docs/documentation/tests,docs/documentation/dist -nsu -B -e $MVN_HTTP_CONFIG -Pdocumentation

- id: upload-keycloak-documentation
name: Upload Keycloak documentation
Expand All @@ -85,18 +79,12 @@ jobs:
name: Maven cache
uses: ./.github/actions/maven-cache

- id: build-documentation
name: Build Keycloak
- id: build-test-documentation
name: Build and verify Keycloak documentation
shell: bash
run: |
MVN_HTTP_CONFIG="-Dhttp.keepAlive=false -Dmaven.wagon.http.pool=false -Dmaven.wagon.http.retryHandler.class=standard -Dmaven.wagon.http.retryHandler.count=3 -Dmaven.wagon.httpconnectionManager.ttlSeconds=120"
./mvnw install -DskipTests -am -pl docs/documentation/tests -nsu -B -e -Pdocumentation $MVN_HTTP_CONFIG

- id: test-documentation
name: Verify Keycloak documentation
shell: bash
run: |
./mvnw test -Dtest=ExternalLinksTest -am -pl docs/documentation/tests,docs/documentation/dist -nsu -B -e -Pdocumentation
./mvnw install -Dtest=ExternalLinksTest -am -pl docs/documentation/tests -nsu -B -e -Pdocumentation $MVN_HTTP_CONFIG

check:
name: Status Check - Keycloak Documentation
Expand Down
7 changes: 6 additions & 1 deletion docs/documentation/tests/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@

<properties>
<version.log4j>2.17.1</version.log4j>
<!-- this property prevents the warning "WARN FilenoUtil: Native subprocess control requires open access" when using JRuby for the unit tests on JDK17 -->
<surefire.system.args>
--add-opens=java.base/sun.nio.ch=ALL-UNNAMED
--add-opens java.base/java.io=ALL-UNNAMED
</surefire.system.args>
</properties>

<build>
Expand Down Expand Up @@ -134,7 +139,7 @@
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj</artifactId>
<version>2.1.0</version>
<version>2.5.10</version>
<scope>test</scope>
</dependency>
<dependency>
Expand Down
17 changes: 16 additions & 1 deletion .../documentation/tests/src/test/java/org/keycloak/documentation/test/ExternalLinksTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package org.keycloak.documentation.test;

import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;
import org.keycloak.documentation.test.utils.LinkUtils;
Expand All @@ -10,11 +12,24 @@

public class ExternalLinksTest {

static LinkUtils linkUtils = LinkUtils.getInstance();

@BeforeAll
public static void setup() {
linkUtils = LinkUtils.getInstance();
}

@AfterAll
public static void close() {
// this will save a cache with all verified links that will expire after one day.
linkUtils.close();
}

@ParameterizedTest
@MethodSource("org.keycloak.documentation.test.Guides#guides()")
public void checkExternalLinks(String guideName) throws IOException {
Guide guide = new Guide(guideName);
List<LinkUtils.InvalidLink> invalidLinks = LinkUtils.getInstance().findInvalidLinks(guide);
List<LinkUtils.InvalidLink> invalidLinks = linkUtils.findInvalidLinks(guide);
if (!invalidLinks.isEmpty()) {
StringBuilder sb = new StringBuilder();
sb.append("Broken links (" + invalidLinks.size() + ") in guide '" + guideName + "': ");
Expand Down
2 changes: 2 additions & 0 deletions docs/documentation/tests/src/test/resources/ignored-links
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,5 @@ https://kubernetes.io/docs/tutorials/stateful-application/basic-stateful-set/#ro
https://github.com/keycloak/keycloak/blob/main/docs/tests.md#kerberos-server
https://github.com/apache/felix-dev/tree/master/http#using-the-osgi-http-whiteboard
https://github.com/keycloak/keycloak/blob/025778fe9c745316f80b53fe3052aeb314e868ef/js/apps/admin-ui/public/locales/en/dashboard.json#L3
https://github.com/keycloak/keycloak/issues/new?*
https://stackapps.com/apps/oauth/register