feat: Updated dockerhub readme in CI pipeline

Closes #30

.circleci/config.yml

@@ -72,6 +72,7 @@ jobs:
         auth:
           username: $DOCKER_USERNAME
           password: $DOCKER_PASSWORD
+    <<: *resource_class
     <<: *work_directory
     steps:
       - checkout
@@ -91,6 +92,7 @@ jobs:
           ./gradlew check sonar -Dsonar.login=$SONAR_TOKEN -Dgraalvm=true
       - store_test_results:
           path: build/test-results
+
   build:
     executor: jdk-executor
     steps:
@@ -114,6 +116,20 @@ jobs:
       - store_test_results:
           path: build/test-results
 
+  dockerhub_readme:
+    machine:
+      image: ubuntu-2204:2023.04.2
+    <<: *resource_class
+    steps:
+      - checkout
+      - run: |
+          docker run -v $PWD:/workspace \
+              -e DOCKERHUB_USERNAME \
+              -e DOCKERHUB_PASSWORD \
+              -e DOCKERHUB_REPOSITORY='devatherock/ldap-search-api' \
+              -e README_FILEPATH='/workspace/README.md' \
+              peterevans/dockerhub-description:3.4.1
+
   integration_test:
     machine:
       image: ubuntu-2004:202010-01
@@ -214,6 +230,12 @@ workflows:
             - docker-credentials
             - changelog-updater-credentials
           <<: *pr_filter
+      - dockerhub_readme:
+          context:
+            - docker-credentials
+            - dockerhub-readme-credentials
+          requires:
+            - changelog_updater
       - validate_yamls:
           context:
             - docker-credentials

CHANGELOG.md

@@ -7,6 +7,9 @@
 - [#7](https://github.com/devatherock/ldap-search-api/issues/7): Query parameter to specify the attributes to be returned in the result
 - [#27](https://github.com/devatherock/ldap-search-api/issues/27): Tests for built-in endpoints like `/health`
 
+### Changed
+- [#30](https://github.com/devatherock/ldap-search-api/issues/30): Updated dockerhub readme in CI pipeline
+
 ## [0.4.0] - 2023-05-22
 ### Added
 - [#2](https://github.com/devatherock/ldap-search-api/issues/2): Unit tests