From 555d365eb98232b88299e2e3ff1ae035e9b39fba Mon Sep 17 00:00:00 2001
From: Thilo Schwarz <osp@thischwa.codes>
Date: Mon, 9 Jun 2025 12:51:17 +0200
Subject: [PATCH] Refactor GitLab CI stages and fix example IP address in
 CfDnsClient documentation

---
 .gitlab-ci.yml                                | 39 +++++++++++--------
 .../java/codes/thischwa/cf/CfDnsClient.java   |  2 +-
 2 files changed, 23 insertions(+), 18 deletions(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 9b08b55..73103a8 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -44,6 +44,20 @@ on_commits:
     - merge_request
     - develop
 
+pages:
+  stage: deploy_pages
+  dependencies:
+    - javadoc
+  script:
+    - echo "deploying gitlab pages from docs/"
+    - mkdir public
+    - cp -r docs/* public/
+  artifacts:
+    paths:
+      - public
+  only:
+    - develop
+
 sonarcloud_scan:
   stage: sonarcloud_scan
   dependencies:
@@ -54,22 +68,10 @@ sonarcloud_scan:
     - merge_requests
     - develop
 
-pages:
-  stage:
-    - on_commit
-    - deploy_pages
-  script:
-    - echo "Deploying GitLab Pages from docs/"
-    - mkdir public
-    - cp -r docs/* public/
-  artifacts:
-    paths:
-      - public
-  only:
-    - develop
-
 javadoc:
   stage: deploy_pages
+  dependencies:
+    - build
   before_script:
     - apk update && apk add git
     - git config --global user.name "${GITLAB_USERNAME}"
@@ -81,13 +83,16 @@ javadoc:
     - mvn javadoc:javadoc -DskipTests -Pjavadoc
     - |
       if ! git diff --quiet -- docs/apidocs; then
-        git add docs/apidocs
+        git add docs
         git commit -m "Update Javadocs [skip ci]"
         git push https://${GITLAB_USERNAME}:${CI_PUSH_TOKEN}@gitlab.com/th-schwarz/CloudflareDNS-java.git ${CI_COMMIT_REF_NAME}
-    - echo "Commits found and pushed"
+        echo "Commits found and pushed"
       else
         echo "No changes to commit"
       fi
   when: manual
   rules:
-    - if: '$CI_COMMIT_REF_NAME == "develop"'
\ No newline at end of file
+    - if: '$CI_COMMIT_REF_NAME == "develop"'
+  artifacts:
+    paths:
+      - docs/apidocs
diff --git a/src/main/java/codes/thischwa/cf/CfDnsClient.java b/src/main/java/codes/thischwa/cf/CfDnsClient.java
index d233d95..ff171df 100644
--- a/src/main/java/codes/thischwa/cf/CfDnsClient.java
+++ b/src/main/java/codes/thischwa/cf/CfDnsClient.java
@@ -33,7 +33,7 @@ import lombok.extern.slf4j.Slf4j;
  *     System.out.println("Record Type: " + record.getType() + ", Value: " + record.getContent())
  * );
  * // Create a record for the subdomain "api"
- * RecordEntity created = client.recordCreateSld(zone, "api", 60, RecordType.A, "192.168.1.4");
+ * RecordEntity created = client.recordCreateSld(zone, "api", 60, RecordType.A, "192.168.1.5");
  * System.out.println("Created Record ID: " + created.getId());
  * </code></pre>
  */