feat(storage): add support for GCS as storage driver (#60)

Author: kishorviswanathan

.github/workflows/ci-cd.yml

@@ -44,7 +44,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        storage-driver: [filesystem, memory, s3]
+        storage-driver: [filesystem, memory, s3, gcs]
         db-driver: [postgres, mysql, sqlite]
     steps:
       - name: pnpm install

docs/content/1.getting-started/2.storage-drivers.md

@@ -5,4 +5,5 @@ description: A list of storage drivers available for the GitHub Actions Cache Se
 
 - [File System](/storage-drivers/filesystem)
 - [S3 / MinIO](/storage-drivers/s3)
+- [GCS](/storage-drivers/gcs)
 - [Memory](/storage-drivers/memory)

docs/content/2.storage-drivers/gcs.md

@@ -0,0 +1,60 @@
+---
+title: Google Cloud Storage
+description: This storage driver stores the cache in a GCS bucket.
+---
+
+Driver: `gcs`
+
+This storage driver stores the cache in a GCS bucket.
+
+## Configuration
+
+### `docker-compose` GCS bucket
+
+```yaml [docker-compose.yml]
+version: '3.9'
+
+services:
+  cache-server:
+    image: ghcr.io/falcondev-oss/github-actions-cache-server:latest
+    ports:
+      - '3000:3000'
+    environment:
+      URL_ACCESS_TOKEN: random_token
+      API_BASE_URL: http://localhost:3000
+
+      STORAGE_DRIVER: gcs
+      STORAGE_GCS_BUCKET: gh-actions-cache
+      # Optional, not required if running in GCP
+      STORAGE_GCS_SERVICE_ACCOUNT_KEY: /gcp/config/application_default_credentials.json
+    volumes:
+      - cache-data:/app/.data
+
+      # Use host's application default credentials
+      - $HOME/.config/gcloud:/gcp/config:ro
+
+volumes:
+  cache-data:
+```
+
+### Environment Variables
+
+Don't forget to set the `STORAGE_DRIVER` environment variable to `gcs` to use the GCS storage driver.
+
+#### `STORAGE_GCS_BUCKET`
+
+Example: `gh-actions-cache`
+
+The name of the GCS bucket used for storage.
+
+#### `STORAGE_GCS_SERVICE_ACCOUNT_KEY`
+
+Example: `/config/auth/serviceaccount.json`
+
+Path to the service account key used for authentication. If not set, [Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials) is used.
+
+#### `STORAGE_GCS_ENDPOINT`
+
+Example: `http://localhost:9000`
+
+The API endpoint for GCS.

package.json

@@ -24,6 +24,7 @@
     "extends": "gh:falcondev-it/configs/changelogithub"
   },
   "dependencies": {
+    "@google-cloud/storage": "^7.12.1",
     "@types/better-sqlite3": "^7.6.11",
     "@types/pg": "^8.11.6",
     "better-sqlite3": "^11.1.2",