Update zendesk client

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Introduction of spotless: https://github.com/cloudbees-oss/zendesk-java-client/pull/602
+b10b28ab9bb2f269795376b7465f8676ed4292db

.github/CODEOWNERS

@@ -5,4 +5,4 @@
 # @cloudbees/team-support will be requested for
 # review when someone opens a pull request.
 
-*       @aheritier @johnou @duemir
+*       @aheritier @johnou @duemir @PierreBtz

.github/dependabot.yml

@@ -8,4 +8,9 @@ updates:
   - package-ecosystem: "maven" # See documentation for possible values
     directory: "/" # Location of package manifests
     schedule:
-      interval: "weekly"
+      interval: "daily"
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/ci.yml → .github/workflows/ci-master.yml

@@ -6,25 +6,24 @@ name: Java CI with Maven
 on:
   push:
     branches: [ master ]
-  pull_request:
-    branches: [ master ]
 
 jobs:
   build:
 
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v6
         with:
           # Disabling shallow clone is recommended for improving relevancy of reporting with SonarCloud
           fetch-depth: 0
-      - name: Set up JDK 1.8
-        uses: actions/setup-java@v1
+      - name: Set up JDK 11
+        uses: actions/setup-java@v5
         with:
-          java-version: 1.8
+          distribution: 'temurin'
+          java-version: 11
       - name: Build with Maven
-        run: mvn --show-version --no-transfer-progress verify --file pom.xml -Pcoverage
+        run: mvn --show-version --no-transfer-progress verify --file pom.xml -Pcoverage,cloudbees-oss-release -Dgpg.skip=true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           ZENDESK_JAVA_CLIENT_TEST_URL: ${{ secrets.ZENDESK_JAVA_CLIENT_TEST_URL }}
@@ -33,10 +32,11 @@ jobs:
           ZENDESK_JAVA_CLIENT_TEST_TOKEN: ${{ secrets.ZENDESK_JAVA_CLIENT_TEST_TOKEN }}
           ZENDESK_JAVA_CLIENT_TEST_REQUESTER_EMAIL: ${{ secrets.ZENDESK_JAVA_CLIENT_TEST_REQUESTER_EMAIL }}
           ZENDESK_JAVA_CLIENT_TEST_REQUESTER_NAME: ${{ secrets.ZENDESK_JAVA_CLIENT_TEST_REQUESTER_NAME }}
-      - name: Set up JDK 11
-        uses: actions/setup-java@v1
+      - name: Set up JDK 17
+        uses: actions/setup-java@v5
         with:
-          java-version: 11
+          distribution: 'temurin'
+          java-version: 17
       - name: Analyze with SonarQube
         run: mvn --show-version --no-transfer-progress sonar:sonar --file pom.xml -Dsonar.organization=cloudbees -Dsonar.host.url=${SONAR_URL} -Dsonar.login=${SONAR_TOKEN}
         env:

.github/workflows/ci-pr.yml

@@ -0,0 +1,28 @@
+# This workflow will build a Java project with Maven
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
+
+name: Java CI with Maven for PRs
+
+on:
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          # Disabling shallow clone is recommended for improving relevancy of reporting with SonarCloud
+          fetch-depth: 0
+      - name: Set up JDK 11
+        uses: actions/setup-java@v5
+        with:
+          distribution: 'temurin'
+          java-version: 11
+      - name: Build with Maven
+        run: mvn --show-version --no-transfer-progress verify --file pom.xml -Pcoverage,cloudbees-oss-release -Dgpg.skip=true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/close-stale-items.yml

@@ -0,0 +1,16 @@
+name: "Close stale issues and PRs"
+on:
+  schedule:
+  - cron: "0 8 * * *"
+
+jobs:
+  default:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/stale@v10
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        only-pr-labels: 'needs-fix'
+        exempt-draft-pr: true
+        stale-issue-message: 'This issue/PR is stale because it has been opened 60 days with no activity. Remove stale label or comment or this will be closed in 7 days'
+

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '30 8 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'java' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v6
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v4
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v4
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v4

.github/workflows/release-drafter.yml

@@ -11,6 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Drafts your next Release notes as Pull Requests are merged into "master"
-      - uses: release-drafter/release-drafter@v5.11.0
+      - uses: release-drafter/release-drafter@v6.1.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.adoc

@@ -26,8 +26,9 @@ Unless code has shipped to users, the initial value of the `serialVersionUID` fi
 
 == Indentation
 
-1. **Use spaces.** Tabs are banned.
-2. **Java blocks are 4 spaces.** JavaScript blocks as for Java. **XML nesting is 2 spaces**
+The project relies on [https://github.com/diffplug/spotless/tree/main/plugin-maven](the Spotless Maven Plugin) to manage its formatting.
+The [https://github.com/google/google-java-format](google-java-format) project was chosen, check it, it contains links to plugins for various IDEs.
+You can also run the formatter from command line: `mvn spotless:apply`.
 
 == Field Naming Conventions
 
@@ -41,42 +42,6 @@ If you need more than three, you are likely doing something wrong and as such yo
 6. It is acceptable to use `e` for the exception in a `try...catch` block.
 7. You shall never use `l` (i.e. lower case `L`) as a variable name.
 
-== Line Length
-
-To the greatest extent possible, please wrap lines to ensure that they do not exceed 120 characters.
-
-== Maven POM file layout
-
-* The `pom.xml` file shall use the sequencing of elements as defined by the `mvn tidy:pom` command (after any indenting fix-up).
-* If you are introducing a property to the `pom.xml` the property must be used in at least two distinct places in the model or a comment justifying the use of a property shall be provided.
-* If the `<plugin>` is in the groupId `org.apache.maven.plugins` you shall omit the `<groupId>`.
-* All `<plugin>` entries shall have an explicit version defined unless inherited from the parent.
-
-== Java code style
-
-=== Modifiers
-
-* For fields, the order is:
-  . `public` / `protected` / `private`
-  . `static`
-  . `final`
-  . `transient`
-  . `volatile`
-* For methods, the order is:
-  . `public` / `protected` / `private`
-  . `abstract`
-  . `static`
-  . `final`
-  . `synchronized`
-  . `native`
-  . `strictfp`
-*  For classes, the order is:
-  .  `public` / `protected` / `private`
-  .  `abstract`
-  .  `static`
-  .  `final`
-  .  `strictfp`
-
 === Imports
 
 * For code in `src/main`:
@@ -89,11 +54,6 @@ To the greatest extent possible, please wrap lines to ensure that they do not ex
   . `import static org.hamcrest.Matchers.*`, `import static org.junit.Assert.*`, `import static org.junit.Assume.*` are expressly encouraged and permitted.
     Any other `static` `*` imports are discouraged unless code readability is significantly enhanced and the import is restricted to a single class.
 
-=== Annotation placement
-
-* Annotations on classes, interfaces, annotations, enums, methods, fields and local variables shall be on the lines immediately preceding the line where modifier(s) (e.g. `public` / `protected` / `private` / `final`, etc) would be appropriate.
-* Annotations on method arguments shall, to the largest extent possible, be on the same line as the method argument (and, if present, before the `final` modifier)
-
 === Javadoc
 
 * Each class shall have a Javadoc comment.
@@ -138,31 +98,20 @@ public void setWidgetCount(int widgetCount) {
   The version shall be `FIXME` to indicate that the person merging the change should replace the `FIXME` with the next release version number.
   The fields and methods within a class/interface (but not nested classes) will be assumed to have the `@since` annotation of their class/interface unless a different `@since` annotation is present.
 
-=== IDE Configuration
-
-* Eclipse, by and large the IDE defaults are acceptable with the following changes:
-** Tab policy to `Spaces only`
-** Indent statements within `switch` body
-** Maximum line width `120`
-** Line wrapping, ensure all to `wrap where necessary`
-** Organize imports alphabetically, no grouping
-* NetBeans, by and large the IDE defaults are acceptable with the following changes:
-** Tabs and Indents
-*** Change Right Margin to `120`
-*** Indent case statements in switch
-** Wrapping
-*** Change all the `Never` values to `If Long`
-*** Select the checkbox for Wrap After Assignment Operators
-* IntelliJ, by and large the IDE defaults are acceptable with the following changes:
-** Wrapping and Braces
-*** Change `Do not wrap` to `Wrap if long`
-*** Change `Do not force` to `Always`
-** Javadoc
-*** Disable generating `<p/>` on empty lines
-** Imports
-*** Class count to use import with '*': `9999`
-*** Names count to use static import with '*': `99999`
-*** Import Layout
-**** import all other imports
-**** blank line
-**** import static all other imports
+== Integration Tests
+
+This library has a set of integration tests in the class `src/test/java/org/zendesk/client/v2/RealSmokeTest.java`. These tests are used to validate the API calls with a real Zendesk instance. The project never got access to a specific sandbox provided by @zendesk thus we are using the sandbox used by CloudBees.
+
+Some of these tests are sadly relying on some specific data of this instance (ex: https://github.com/cloudbees-oss/zendesk-java-client/blob/master/src/test/java/org/zendesk/client/v2/RealSmokeTest.java#L102-L103) and thus you cannot expect to execute all of them in a different instance.
+
+To execute these tests you have to pass several settings in the file `src/test/resources/zendesk.properties`:
+
+```
+url=#A ZENDESK SANDBOX URL#
+username=#A EMAIL OF AN ACCOUNT HAVING ACCESS TO THE INSTANCE#
+password=#THE PASSWORD OF THE ACCOUNT#
+token=#A TOKEN TO ACCESS TO THE INSTANCE#
+requester.email=#A EMAIL - can be like username - TO CREATE THE REPORTER#
+requester.name=#A NAME FOR THE REPORTER#
+```
+