Merge remote-tracking branch 'origin/main'

Author: otary

.github/workflows/ci-build.yml

@@ -16,11 +16,11 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Setup JDK 8
+      - name: Setup JDK 11
         uses: actions/setup-java@v3
         with:
           distribution: temurin
-          java-version: 8
+          java-version: 11
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v3
       - name: GitLab4j verify

.gitignore

@@ -16,7 +16,7 @@
 *.pydevproject
 .project
 .metadata
-/bin
+bin/
 tmp/
 *.tmp
 *.bak

README.md

@@ -7,69 +7,40 @@
 GitLab4J™ API (gitlab4j-api) provides a full featured and easy to consume Java library for working with GitLab repositories via the GitLab REST API.  Additionally, full support for working with GitLab webhooks and system hooks is also provided.
 
 ---
-## Table of Contents
-* [GitLab Server Version Support](#gitLab-server-version-support)<br/>
-* [Using GitLab4J-API](#using-gitlab4j-api)<br/>
-  * [Java 8 Requirement](#java-8-requirement)<br/>
-  * [Javadocs](#javadocs)<br/>
-  * [Project Set Up](#project-set-up)<br/>
-  * [Usage Examples](#usage-examples)<br/>
-  * [Setting Request Timeouts](#setting-request-timeouts)<br/>
-  * [Connecting Through a Proxy Server](#connecting-through-a-proxy-server)<br/>
-  * [GitLab API V3 and V4 Support](#gitLab-api-v3-and-v4-support)<br/>
-  * [Logging of API Requests and Responses](#logging-of-api-requests-and-responses)<br/>
-  * [Results Paging](#results-paging)<br/>
-  * [Java 8 Stream Support](#java-8-stream-support)<br/>
-    * [Eager evaluation example usage](#eager-evaluation-example-usage)<br/>
-    * [Lazy evaluation example usage](#lazy%20evaluation-example-usage)<br/>
-  * [Java 8 Optional&lt;T&gt; Support](#java-8-optional-support)<br/>
-  * [Issue Time Estimates](#issue-time-estimates)<br/>
-* [Making API Calls](#making-api-calls)<br/>
-  * [Available Sub APIs](#available-sub-apis)
-
----
-
-> **Warning**
-> If you are looking for our next major version `6.x.x` which is requiring **Java 11** as mimimal version and which is using Jakarta EE components using the `jakarta.*` packages instead of `javax.*` check the [`6.x` branch](https://github.com/gitlab4j/gitlab4j-api/tree/6.x).
-> The `6.x.x` version is the one you need if you are using Spring Boot 3 and Spring Framework 6.0, . 
-
 ## GitLab Server Version Support
 
-GitLab4J-API supports version 11.0+ of GitLab Community Edition [(gitlab-ce)](https://gitlab.com/gitlab-org/gitlab-ce/) and GitLab Enterprise Edition [(gitlab-ee)](https://gitlab.com/gitlab-org/gitlab-ee/). 
-
-GitLab released GitLab Version 11.0 in June of 2018 which included many major changes to GitLab.  If you are using GitLab server earlier than version 11.0, it is highly recommended that you either update your GitLab install or use a version of this library that was released around the same time as the version of GitLab you are using. 
+GitLab4J-API supports both GitLab Community Edition [(gitlab-ce)](https://gitlab.com/gitlab-org/gitlab-ce/) and GitLab Enterprise Edition [(gitlab-ee)](https://gitlab.com/gitlab-org/gitlab-ee/).
 
 **NOTICE**:  
 As of GitLab 11.0 support for the GitLab API v3 has been removed from the GitLab server (see https://about.gitlab.com/2018/06/01/api-v3-removal-impending/). Support for GitLab API v3 will be removed from this library sometime in 2019. If you are utilizing the v3 support, please update your code to use GitLab API v4.
 
 ---
 ## Using GitLab4J-API
 
-### **Java 8 Requirement**
-As of GitLab4J-API 4.8.0, Java 8+ is now required to use GitLab4J-API.
+### **Java 11 Requirement**
+As of GitLab4J-API 6.0.0, Java 11+ is now required to use GitLab4J-API.
 
 ### **Javadocs**
 Javadocs are available here: [![javadoc.io](https://javadoc.io/badge2/org.gitlab4j/gitlab4j-api/javadoc.io.svg)](https://javadoc.io/doc/org.gitlab4j/gitlab4j-api)
 
 
 ### **Project Set Up**
 To utilize GitLab4J&trade; API in your Java project, simply add the following dependency to your project's build file:<br /> 
+
 **Gradle: build.gradle**
 ```java
 dependencies {
     ...
-    compile group: 'org.gitlab4j', name: 'gitlab4j-api', version: '5.7.0'
+    implementation group: 'org.gitlab4j', name: 'gitlab4j-api', version: '6.0.0-rc.7'
 }
 ```
 
-**NOTE:** Pulling dependencies may fail when using Gradle prior to 4.5. See [Gradle issue 3065](https://github.com/gradle/gradle/issues/3065#issuecomment-364092456)
-
 **Maven: pom.xml**
 ```xml
 <dependency>
     <groupId>org.gitlab4j</groupId>
     <artifactId>gitlab4j-api</artifactId>
-    <version>5.7.0</version>
+    <version>6.0.0-rc.7</version>
 </dependency>
 ```
 
@@ -80,7 +51,7 @@ dependencies {
  Just add this line at the top of your script:
 
 ```java
-//DEPS org.gitlab4j:gitlab4j-api:5.7.0
+//DEPS org.gitlab4j:gitlab4j-api:6.0.0-rc.7
 ```
 
 **Ivy and SBT**<br/>
@@ -148,20 +119,44 @@ You can also point to a specific commit:
 
 ```gradle
 dependencies {
-    implementation 'com.github.gitlab4j:gitlab4j-api:6561c93aaf'
+    implementation 'com.github.gitlab4j:gitlab4j-api:7dfec10189'
 }
 ```
 
 ```xml
 <dependency>
     <groupId>com.github.gitlab4j</groupId>
     <artifactId>gitlab4j-api</artifactId>
-    <version>6561c93aaf</version>
+    <version>7dfec10189</version>
 </dependency>
 ```
 
 ```java
-//DEPS https://github.com/gitlab4j/gitlab4j-api/tree/6561c93aafa6bf35cb9bad0617127a0c249a8f9f
+//DEPS https://github.com/gitlab4j/gitlab4j-api/tree/7dfec10189cdcb11e34fc9ead984abcd6316194a
+```
+
+---
+
+### **Models jar**
+
+For some usages, the HTTP layer based on Jersey can't be used.
+Those projects might want to use the Jackson-based model classes, and implement the REST call themself.
+
+**Gradle: build.gradle**
+```java
+dependencies {
+    ...
+    implementation 'org.gitlab4j:gitlab4j-models:6.0.0-rc.7'
+}
+```
+
+**Maven: pom.xml**
+```xml
+<dependency>
+    <groupId>org.gitlab4j</groupId>
+    <artifactId>gitlab4j-models</artifactId>
+    <version>6.0.0-rc.7</version>
+</dependency>
 ```
 
 ---
@@ -641,7 +636,7 @@ List<Runner> runners = gitLabApi.getRunnersApi().getAllRunners();
 #### SearchApi
 ```java
 // Do a global search for Projects
-List<?> projects = gitLabApi.getSearchApi().globalSearch(SearchScope.PROJECTS, "text-to-search-for");
+List<Project> projects = gitLabApi.getSearchApi().globalSearch(SearchScope.PROJECTS, "text-to-search-for");
 ```
 
 #### ServicesApi

build.gradle

@@ -1,9 +1,5 @@
-
 plugins {
-    id 'java-library'
-    id 'com.diffplug.spotless' version '6.2.0'
-    id 'signing'
-    id 'maven-publish'
+    id 'com.diffplug.spotless' version '6.25.0' apply false
     id 'io.github.gradle-nexus.publish-plugin' version '1.3.0'
     id 'net.researchgate.release' version '3.0.2'
 }
@@ -12,58 +8,52 @@ wrapper {
     gradleVersion = '7.6.2'
 }
 
-group = 'org.gitlab4j'
-
-dependencies {
-    api 'jakarta.activation:jakarta.activation-api:1.2.2'
-    api 'org.glassfish.jersey.inject:jersey-hk2:2.39.1'
-    api 'org.glassfish.jersey.core:jersey-client:2.39.1'
-    api 'org.glassfish.jersey.connectors:jersey-apache-connector:2.39.1'
-    api 'org.glassfish.jersey.media:jersey-media-multipart:2.39.1'
-    api 'org.glassfish.jersey.media:jersey-media-json-jackson:2.39.1'
-    api 'jakarta.servlet:jakarta.servlet-api:4.0.4'
-    testImplementation 'org.mockito:mockito-core:4.4.0'
-    testImplementation 'org.mockito:mockito-junit-jupiter:4.4.0'
-    testImplementation 'org.hamcrest:hamcrest-all:1.3'
-    testImplementation 'uk.org.webcompere:system-stubs-jupiter:1.2.0'
-    testImplementation "org.junit.jupiter:junit-jupiter-api:5.10.4"
-    testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:5.10.4"
-}
+String groupId = 'org.gitlab4j'
 
-signing {
-    useGpgCmd()
-    sign(publishing.publications)
-}
+subprojects {
+    apply plugin: 'java-library'
+    apply plugin: 'signing'
+    apply plugin: 'com.diffplug.spotless'
+    apply plugin: 'maven-publish'
 
-tasks.withType(Sign) {
-    onlyIf {
-        project.hasProperty('signing.gnupg.keyName')
+    group = groupId
+
+    signing {
+        useGpgCmd()
+        sign(publishing.publications)
+    }
+
+    tasks.withType(Sign) {
+        onlyIf {
+            project.hasProperty('signing.gnupg.keyName')
+        }
     }
-}
 
-java {
-    withJavadocJar()
-    withSourcesJar()
+    java {
+        withJavadocJar()
+        withSourcesJar()
 
-    compileJava.options.encoding = "UTF-8"
-    toolchain {
-        languageVersion = JavaLanguageVersion.of(8)
+        compileJava.options.encoding = "UTF-8"
+        toolchain {
+            languageVersion = JavaLanguageVersion.of(11)
+        }
     }
-}
 
-tasks.named('test') {
-    useJUnitPlatform()
-}
+    spotless {
+        java {
+            palantirJavaFormat()
+            importOrder 'java', 'javax', 'jakarta', 'org', 'com', ''
+            removeUnusedImports()
+        }
+    }
 
-repositories {
-    mavenCentral()
-}
+    repositories {
+        // mavenLocal()
+        mavenCentral()
+    }
 
-spotless {
-    java {
-        palantirJavaFormat()
-        importOrder 'java', 'javax', 'jakarta', 'org', 'com', ''
-        removeUnusedImports()
+    tasks.named('test') {
+        useJUnitPlatform()
     }
 }
 
@@ -78,47 +68,6 @@ nexusPublishing {
     }
 }
 
-publishing {
-    publications {
-        mavenJava(MavenPublication) {
-            pom {
-                name = 'GitLab4J-API - GitLab API Java Client'
-                description = 'GitLab4J-API (gitlab4j-api) provides a full featured Java client library for working with GitLab repositories and servers via the GitLab REST API.'
-                packaging = 'jar'
-                url = 'https://' + "$githubRepositoryOwner" + '.github.io/' + "$githubRepositoryName" + '/'
-                licenses {
-                    license {
-                        name = 'The MIT License (MIT)'
-                        url = 'http://opensource.org/licenses/MIT'
-                        distribution = 'repo'
-                    }
-                }
-                developers {                                   
-                    developer {
-                        id = 'gmessner'
-                        name =  'Greg Messner'
-                        email = 'greg@messners.com'
-                    }
-                    developer {
-                        id = 'gdesaintmartinlacaze'
-                        name =  'Gautier de Saint Martin Lacaze'
-                        email = 'gautier@jabby-techs.fr'
-                    }
-                    developer {
-                        url = 'https://github.com/orgs/' + "$githubRepositoryOwner" + '/people'
-                    }
-                }
-                scm {
-                    connection = 'scm:git:https://github.com/' + "$githubRepositoryOwner" + '/' + "$githubRepositoryName" + '.git'
-                    developerConnection = 'scm:git:https://github.com/' + "$githubRepositoryOwner" + '/' + "$githubRepositoryName" + '.git'
-                    url = 'https://github.com/' + "$githubRepositoryOwner" + '/' + "$githubRepositoryName" + '/'
-                }
-            }
-            from components.java
-        }
-    }
-}
-
 release {
     buildTasks = ['doRelease']
     git {
@@ -144,16 +93,21 @@ def updateLastVersionValueTask = tasks.register('updateLastVersionValue') {
         def newVersion = project.findProperty('release.releaseVersion') ?: version.replace('-SNAPSHOT', '')
         content = content.replaceAll("lastVersion=[0-9a-z\\.\\-]+", "lastVersion=" + newVersion)
         propertiesFile.text = content
+
+        def readmeFile = file('README.md')
+        def readme = readmeFile.text
+        readme = readme.replace(lastVersion, newVersion)
+        readmeFile.text = readme
     }
 }
 
-tasks.register('doRelease') {
+task doRelease {
     dependsOn(
-        checkLastVersionValueTask,
-        'initializeSonatypeStagingRepository', 
-        'clean',
-        'build',
-        project.getTasksByName('publishToSonatype', true)
+            checkLastVersionValueTask,
+            'initializeSonatypeStagingRepository', 
+            'clean',
+            'build',
+            project.getTasksByName('publishToSonatype', true)
     )
 }