Improve README.md and the release.yml workflow (#13)

* improve README.md and the release.yml workflow

* add a section describing on how to generated the pg_catalog jOOQ sources

* add declarative management section to the README.md

* improve wording

* fix the release.yml workflow

* fix company name in file LICENSE

* lowercase the URLs

* Revert "fix company name in file LICENSE"

This reverts commit 5a639a7.

Author: ThoSap

.github/workflows/release.yml

@@ -47,8 +47,7 @@ jobs:
         env:
           GITHUB_USER_NAME: ${{ github.actor }}
           GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Build Docker image
-        uses: aboutbits/github-actions-docker/build-push@v1
+      - uses: aboutbits/github-actions-docker/build-push@v1
         with:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
@@ -70,6 +69,9 @@ jobs:
             helm install postgresql-operator https://github.com/${{ github.repository }}/releases/download/v${{ steps.nextVersion.outputs.version }}/postgresql-operator-${{ steps.nextVersion.outputs.version }}.tgz
             ```
             
+            With the Helm chart, the Custom Resource Definitions (CRDs) are installed automatically.
+            However, if you deploy the operator directly from the OCI image, the CRDs are not automatically applied and must be installed separately.
+            
             ### Manual CRD Installation
             ```bash
             kubectl apply -f https://github.com/${{ github.repository }}/releases/download/v${{ steps.nextVersion.outputs.version }}/clusterconnections.postgresql.aboutbits.it-v1.yml
@@ -86,3 +88,10 @@ jobs:
         run: |
           gh release upload v${{ steps.nextVersion.outputs.version }} operator/build/helm/kubernetes/*.tgz operator/build/kubernetes/*.postgresql.aboutbits.it-v1.yml
         shell: bash
+      - name: Update README.md
+        run: |
+          sed -i "s|releases/download/v[0-9.]*/postgresql-operator-[0-9.]*.tgz|releases/download/v${{ steps.nextVersion.outputs.version }}/postgresql-operator-${{ steps.nextVersion.outputs.version }}.tgz|g" README.md
+          git add README.md
+          git diff-index --quiet HEAD || git commit -m "update README.md with version ${{ steps.nextVersion.outputs.version }}"
+          git push
+        shell: bash

README.md

@@ -31,6 +31,18 @@ AboutBits PostgreSQL Operator is a Kubernetes operator that helps you manage Pos
 └──────────────────────────────────────────────────────────────────────────┘
 ```
 
+## Installation
+
+### Helm Chart
+
+```bash
+helm install postgresql-operator https://github.com/aboutbits/postgresql-operator/releases/download/v0.1.1/postgresql-operator-0.1.1.tgz
+```
+
+With the Helm chart, the Custom Resource Definitions (CRDs) are installed automatically.  
+However, if you deploy the operator directly from the OCI image, the CRDs are not automatically applied and must be installed separately.  
+See the release notes for the [latest version](https://github.com/aboutbits/postgresql-operator/releases/latest) for more information.
+
 ## Usage
 
 This operator allows you to manage PostgreSQL resources using Kubernetes manifests.  
@@ -43,6 +55,30 @@ Further documentation of each Custom Resource can be found here:
 - [Grant](docs/grant.md) - Manage privileges.
 - [DefaultPrivilege](docs/default-privilege.md) - Manage default privileges.
 
+### Declarative Management
+
+The Operator leverages the power of Kubernetes Custom Resource Definitions (CRDs) to manage PostgreSQL resources declaratively.
+This means the Operator continuously reconciles the state of the cluster to match your desired state defined in the CRs.
+
+**Updates**
+
+If you modify a mutable field in a Custom Resource, the Operator automatically applies these changes to the PostgreSQL cluster.  
+The operator, for example, handles:
+
+- Changing a `Role`'s flags, password, or comment.
+- Updating the `Role` password if the password in the referenced Secret changes.
+- Updating `Grant`/`DefaultPrivilege` objects or privileges.
+- Changing a `Schema` or `Database` owner.
+
+**Deletions**
+
+Deleting a Custom Resource triggers the cleanup of the corresponding PostgreSQL object:
+
+- For `Grant`, `DefaultPrivilege`, and `Role` resources, the operator revokes privileges or drops the role.
+- For `Database` and `Schema` resources, the behavior depends on the `reclaimPolicy` (defaults to `Retain` to prevent accidental data loss).
+
+This ensures that your PostgreSQL cluster configuration always reflects your Kubernetes manifests, simplifying management and automation.
+
 ### Showcase
 
 The following example shows how to set up a connection to a PostgreSQL cluster, create a database and schema, a login role (user), and configure permissions.
@@ -212,6 +248,28 @@ make test
 
 Afterward, the project can be started in IntelliJ by navigating to `Run` -> `Run '...'`.
 
+#### Generating jOOQ sources
+
+To update the generated jOOQ sources from schema `pg_catalog`, you need to run the application in dev mode first to start the PostgreSQL Dev Service:
+
+```bash
+make run
+
+# or
+
+./gradlew :operator:quarkusDev
+```
+
+Once the application is running (and the database is available on port 5432), run the following command:
+
+```bash
+make generate-jooq
+
+# or
+
+./gradlew :generated:jooqCodegen
+```
+
 ### Docker Environment
 
 See [Docker Environment](docs/docker-environment.md) for setting up a local development environment using Quarkus Dev Services.