@rharkor/caching-for-turbo 2.1.0 → 2.1.2

package/README.md

@@ -55,7 +55,7 @@ the following step **before** you run `turbo build`:
 
 ```yaml
 - name: Cache for Turbo
-  uses: rharkor/caching-for-turbo@v2.0.0
+  uses: rharkor/caching-for-turbo@v2.1.1
 ```
 
 This GitHub Action facilitates:
@@ -69,16 +69,16 @@ This GitHub Action facilitates:
 
 ## Local Development
 
-You can also use this package as a devDependency to run the cache server locally
-during development. This allows you to use the same caching infrastructure
-(including S3) that you use in CI.
+You can also use this package as a global dependency to run the cache server
+locally during development. This allows you to use the same caching
+infrastructure (including S3) that you use in CI.
 
 ### Installation
 
-Add this package as a devDependency to your project:
+Add this package as a global dependency:
 
 ```bash
-npm install --save-dev @rharkor/caching-for-turbo
+npm install -g @rharkor/caching-for-turbo
 ```
 
 ### Usage
@@ -88,22 +88,22 @@ server:
 
 ```bash
 # Start the server in background mode (recommended for development)
-npx turbogha
+turbogha start
 
 # Or run the server in foreground mode
-npx turbogha --server
+turbogha start --foreground
 ```
 
 To stop the server, you can use the following command:
 
 ```bash
-curl -X DELETE http://localhost:41230/shutdown
+turbogha kill
 ```
 
 To ping the server, you can use the following command:
 
 ```bash
-npx turbogha --ping
+turbogha ping
 ```
 
 ### Environment Configuration
@@ -115,11 +115,11 @@ Create a `.env` file in your project root to configure the cache server:
 PROVIDER=s3
 
 # S3 Configuration (required when using s3 provider)
-S3_ACCESS_KEY_ID=your-access-key
-S3_SECRET_ACCESS_KEY=your-secret-key
-S3_BUCKET=your-bucket-name
-S3_REGION=us-east-1
-S3_ENDPOINT=https://s3.amazonaws.com
+AWS_ACCESS_KEY_ID=secret # Or S3_ACCESS_KEY_ID
+AWS_SECRET_ACCESS_KEY=secret # Or S3_SECRET_ACCESS_KEY
+AWS_REGION=us-east-1 # Or AWS_DEFAULT_REGION or S3_REGION
+AWS_ENDPOINT_URL_S3=https://s3.amazonaws.com # Or AWS_ENDPOINT_URL or S3_ENDPOINT
+S3_BUCKET=my-bucket
 S3_PREFIX=turbogha/
 
 # Optional: Custom cache prefix
@@ -140,7 +140,6 @@ export TURBO_TEAM=turbogha
 turbo build
 ```
 
-_**Note:** Store the environment variables in a .env for turbo to use them._
 _See: https://turborepo.com/docs/reference/system-environment-variables_
 
 ### Stopping the Server
@@ -148,41 +147,11 @@ _See: https://turborepo.com/docs/reference/system-environment-variables_
 To stop the cache server:
 
 ```bash
+turbogha kill
+# or
 curl -X DELETE http://localhost:41230/shutdown
 ```
 
-### Development Workflow Example
-
-1. **Start the cache server:**
-
-   ```bash
-   npx turbogha
-   ```
-
-2. **Set up environment variables:**
-
-   ```bash
-   export TURBO_API=http://localhost:41230
-   export TURBO_TOKEN=turbogha
-   export TURBO_TEAM=turbogha
-   ```
-
-3. **Run your builds with remote caching:**
-
-   ```bash
-   turbo build
-   turbo test
-   ```
-
-4. **Stop the server when done:**
-   ```bash
-   curl -X DELETE http://localhost:41230/shutdown
-   ```
-
-This setup allows you to use the same S3-based caching infrastructure locally
-that you use in your CI pipeline, ensuring consistent caching behavior across
-environments.
-
 ## Configurable Options
 
 Customize the caching behavior with the following optional settings (defaults
@@ -193,7 +162,7 @@ with:
   cache-prefix: turbogha_ # Custom prefix for cache keys
   provider: github # Storage provider: 'github' (default) or 's3'
 
-  # S3 Provider Configuration (required when provider is set to 's3')
+  # S3 Provider Configuration (variables will be read from environment variables if not provided)
   s3-access-key-id: ${{ secrets.S3_ACCESS_KEY_ID }} # S3 access key
   s3-secret-access-key: ${{ secrets.S3_SECRET_ACCESS_KEY }} # S3 secret key
   s3-bucket: your-bucket-name # S3 bucket name
@@ -231,14 +200,10 @@ Example S3 configuration:
 
 ```yaml
 - name: Cache for Turbo
-  uses: rharkor/caching-for-turbo@v2.0.0
+  uses: rharkor/caching-for-turbo@v2.1.1
   with:
     provider: s3
-    s3-access-key-id: ${{ secrets.S3_ACCESS_KEY_ID }}
-    s3-secret-access-key: ${{ secrets.S3_SECRET_ACCESS_KEY }}
     s3-bucket: my-turbo-cache-bucket
-    s3-region: us-west-2
-    s3-endpoint: https://s3.amazonaws.com
 ```
 
 ### Cache Cleanup Options
@@ -269,14 +234,10 @@ Example with cleanup configuration:
 
 ```yaml
 - name: Cache for Turbo
-  uses: rharkor/caching-for-turbo@v2.0.0
+  uses: rharkor/caching-for-turbo@v2.1.1
   with:
     provider: s3
-    s3-access-key-id: ${{ secrets.S3_ACCESS_KEY_ID }}
-    s3-secret-access-key: ${{ secrets.S3_SECRET_ACCESS_KEY }}
     s3-bucket: my-turbo-cache-bucket
-    s3-region: us-west-2
-    s3-endpoint: https://s3.amazonaws.com
     # Cleanup configuration
     max-age: 2w
     max-size: 5gb
@@ -314,4 +275,3 @@ file.
 This project is inspired by
 [dtinth](https://github.com/dtinth/setup-github-actions-caching-for-turbo) and
 has been comprehensively rewritten for enhanced robustness and reliability.
-