docs: first draft

Signed-off-by: Niccolò Fei <[email protected]>

Author: NiccoloFei

.github/workflows/bake.yml

@@ -1,4 +1,4 @@
-name: Build and publish extensions
+name: Build, test and publish extensions
 
 on:
   push:
@@ -54,3 +54,5 @@ jobs:
     with:
       environment: ${{ (github.ref == 'refs/heads/main') && 'production' || 'testing'}}
       extension_name: ${{ matrix.name }}
+    secrets:
+      SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}

.github/workflows/bake_targets.yml

@@ -1,4 +1,4 @@
-name: Build target extension
+name: Build, test and publish a target extension
 
 on:
   workflow_call:

.github/workflows/update.yml

@@ -4,7 +4,6 @@
 name: Update Extension versions
 
 on:
-  push:
   schedule:
     - cron: 0 0 * * 1
   workflow_dispatch:
@@ -13,7 +12,7 @@ defaults:
   run:
     shell: 'bash -Eeuo pipefail -x {0}'
 
-permissions: read-all
+permissions: {}
 
 jobs:
   fetch-extensions:
@@ -43,7 +42,6 @@ jobs:
         extension: ${{fromJson(needs.fetch-extensions.outputs.extensions)}}
     permissions:
       contents: write
-      pull-requests: write
     steps:
       - name: Checkout repository
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
@@ -99,6 +97,7 @@ jobs:
         uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7
         if: github.ref == 'refs/heads/main'
         with:
+          token: ${{ secrets.REPO_GHA_PAT }}
           title: "chore: update ${{ matrix.extension }} versions"
           body: "Updating the versions of ${{ matrix.extension }}"
           branch: "${{ matrix.extension }}-update"

README.md

@@ -20,8 +20,8 @@ in CloudNativePG.
 
 ## Supported Extensions
 
-Currently: **none**.
-This repository lays the foundation for packaging extensions going forward.
+Currently:
+- **pgvector** - Open-source vector similarity search for PostgreSQL
 
 ---
 
@@ -34,18 +34,18 @@ Each extension image tag follows this format:
 ```
 
 **Example:**
-Building `pgvector` version `0.8.1` on PostgreSQL `17.6` for the `trixie`
+Building `pgvector` version `0.8.1` on PostgreSQL `18.0` for the `trixie`
 distro, with build timestamp `202509101200`, results in:
 
 ```
-pgvector:17.6-0.8.1-202509101200-trixie
+pgvector:18.0-0.8.1-202509101200-trixie
 ```
 
 For convenience, **rolling tags** should also be published:
 
 ```
-pgvector:17.6-0.8.1-trixie
-pgvector:17-0.8.1-trixie
+pgvector:18.0-0.8.1-trixie
+pgvector:18-0.8.1-trixie
 ```
 
 This scheme ensures:

pgvector/README.md

@@ -1 +1,44 @@
-# TODO
+# PgVector
+
+[PgVector](https://github.com/pgvector/pgvector) is an open-source vector similarity search for PostgreSQL.
+
+## How It Works
+
+To use this extension container image, first add it to your Cluster.
+For example:
+
+```yaml
+apiVersion: postgresql.cnpg.io/v1
+kind: Cluster
+metadata:
+  name: cluster-pgvector
+spec:
+  imageName: ghcr.io/cloudnative-pg/postgresql:18-minimal-trixie
+  instances: 1
+
+  storage:
+    size: 1Gi
+
+  postgresql:
+    extensions:
+      - name: pgvector
+        image:
+          reference: ghcr.io/cloudnative-pg/pgvector:18-0.8.1-trixie
+```
+
+Then, create or add it to an existing Database object to install the extension in a target database.
+For example, to add it to the `app` Database:
+
+```yaml
+apiVersion: postgresql.cnpg.io/v1
+kind: Database
+metadata:
+  name: cluster-pgvector-app
+spec:
+  name: app
+  owner: app
+  cluster:
+    name: cluster-pgvector
+  extensions:
+  - name: vector
+```