Merge pull request #601 from Aiven-Open/jeqo/docs

chore: add config docs generation

Author: biggusdonzus

.github/workflows/git.yml

@@ -10,3 +10,17 @@ jobs:
     - uses: actions/checkout@v3
     - name: Block Fixup Commit Merge
       uses: alexkappa/block-fixup-merge-action@v2
+
+    - name: Gen docs
+      run: make docs
+
+    - name: Check for uncommitted changes
+      run: |
+        if [[ -n $(git status -s) ]]; then
+          echo "There are uncommitted changes after the task:"
+          git status -s
+          exit 1
+        else
+          echo "No changes detected."
+        fi
+      shell: bash

Makefile

@@ -42,6 +42,10 @@ storage/gcs/build/distributions/gcs-$(VERSION).tgz:
 storage/azure/build/distributions/azure-$(VERSION).tgz:
 	./gradlew build :storage:azure:distTar -x test -x integrationTest -x e2e:test
 
+.PHONY: docs
+docs:
+	./gradlew :docs:genConfigDocs
+
 test: build
 	./gradlew test -x e2e:test
 

commons/src/main/java/io/aiven/kafka/tieredstorage/config/validators/NonEmptyPassword.java

@@ -33,4 +33,9 @@ public void ensureValid(final String name, final Object value) {
             throw new ConfigException(name + " value must not be empty");
         }
     }
+
+    @Override
+    public String toString() {
+        return "Non-empty password text";
+    }
 }

commons/src/main/java/io/aiven/kafka/tieredstorage/config/validators/Null.java

@@ -44,5 +44,10 @@ public void ensureValid(final String name, final Object value) {
             validator.ensureValid(name, value);
         }
     }
+
+    @Override
+    public String toString() {
+        return "null or " + validator.toString();
+    }
 }
 

commons/src/main/java/io/aiven/kafka/tieredstorage/config/validators/Subclass.java

@@ -40,5 +40,9 @@ public void ensureValid(final String name, final Object value) {
             throw new ConfigException(name + " should be a subclass of " + parentClass.getCanonicalName());
         }
     }
-
+        
+    @Override
+    public String toString() {
+        return "Any implementation of " + parentClass.getName();
+    }
 }

commons/src/main/java/io/aiven/kafka/tieredstorage/config/validators/ValidUrl.java

@@ -43,4 +43,9 @@ public void ensureValid(final String name, final Object value) {
             }
         }
     }
+
+    @Override
+    public String toString() {
+        return "Valid URL as defined in rfc2396";
+    }
 }