Merge pull request #4 from runloopai/jrvb-misc-fixes

Add version to examples, plus other small fixes

Author: jrvb-rl

README.md

@@ -14,14 +14,15 @@ A GitHub Action to deploy agents to the [Runloop](https://runloop.ai) platform.
 
 ## Quick Start
 
-### Deploy Current Repository as Agent
+### Deploy Current Repository as an Agent
 
 ```yaml
 - name: Deploy agent
   uses: runloopai/deploy-agent@main
   with:
     api-key: ${{ secrets.RUNLOOP_API_KEY }}
     source-type: git
+    agent-version: 1.0.0
 ```
 
 That's it! The action will automatically use your current repository and commit SHA.
@@ -34,6 +35,7 @@ That's it! The action will automatically use your current repository and commit
 |-------|----------|---------|-------------|
 | `api-key` | ✅ | | Runloop API key (store in secrets) |
 | `source-type` | ✅ | | Agent source type: `git`, `tar`, or `file` |
+| `agent-version` | ✅ | | Agent version (semver string like `2.0.65` or git SHA) |
 | `agent-name` | | repo name | Name for the agent (defaults to repository name) |
 | `git-repository` | | current repo | Git repository URL (auto-detected) |
 | `git-ref` | | current commit/tag | Git ref (branch/tag/commit SHA, auto-detected) |
@@ -63,6 +65,7 @@ That's it! The action will automatically use your current repository and commit
   with:
     api-key: ${{ secrets.RUNLOOP_API_KEY }}
     source-type: git
+    agent-version: 1.0.0
     setup-commands: |
       chmod +x scripts/agent.sh
       npm install
@@ -84,6 +87,7 @@ jobs:
         with:
           api-key: ${{ secrets.RUNLOOP_API_KEY }}
           source-type: git
+          agent-version: ${{ github.event.release.tag_name }}
           agent-name: my-agent-${{ github.event.release.tag_name }}
 ```
 
@@ -105,6 +109,7 @@ Basic example:
   with:
     api-key: ${{ secrets.RUNLOOP_API_KEY }}
     source-type: tar
+    agent-version: 1.0.0
     path: agent.tar.gz
     object-ttl-days: 30
 ```
@@ -123,6 +128,7 @@ You can also use `.tar` format or reference output from a previous step:
   with:
     api-key: ${{ secrets.RUNLOOP_API_KEY }}
     source-type: tar
+    agent-version: 1.0.0
     path: ${{ steps.build.outputs.archive-path }}
 ```
 
@@ -133,6 +139,7 @@ You can also use `.tar` format or reference output from a previous step:
   with:
     api-key: ${{ secrets.RUNLOOP_API_KEY }}
     source-type: file
+    agent-version: 1.0.0
     path: ./scripts/agent.sh
 ```
 

action.yml

@@ -56,6 +56,7 @@ inputs:
   object-ttl-days:
     description: 'Time-to-live for uploaded objects in days (optional)'
     required: false
+    # default is 'undefined' => don't auto-delete
 
 outputs:
   agent-id:

dist/index.js

@@ -20,6 +20,7 @@ jobs:
         with:
           api-key: ${{ secrets.RUNLOOP_API_KEY }}
           source-type: git
+          agent-version: 1.0.0
           # agent-name defaults to repository name if not provided
           # git-repository defaults to current repository
           # git-ref defaults to current commit SHA

dist/index.js.map

@@ -20,6 +20,7 @@ jobs:
         with:
           api-key: ${{ secrets.RUNLOOP_API_KEY }}
           source-type: git
+          agent-version: ${{ github.event.release.tag_name }}
           agent-name: my-agent-${{ github.event.release.tag_name }}
           # git-ref automatically uses the release tag
           setup-commands: |

examples/git-auto.yml

@@ -23,6 +23,7 @@ jobs:
         with:
           api-key: ${{ secrets.RUNLOOP_API_KEY }}
           source-type: file
+          agent-version: 1.0.0
           agent-name: my-script-agent
           path: ./scripts/agent.sh  # Path to single file
           setup-commands: |

examples/git-release.yml

@@ -45,6 +45,7 @@ jobs:
         with:
           api-key: ${{ secrets.RUNLOOP_API_KEY }}
           source-type: tar
+          agent-version: 1.0.0
           path: agent.tar.gz
           agent-name: my-tar-agent
           setup-commands: |
@@ -82,6 +83,7 @@ jobs:
         with:
           api-key: ${{ secrets.RUNLOOP_API_KEY }}
           source-type: tar
+          agent-version: ${{ steps.build.outputs.agent-version }}
           path: ${{ steps.build.outputs.archive-path }}
           agent-name: built-agent-${{ steps.build.outputs.agent-version }}
 
@@ -102,6 +104,7 @@ jobs:
         with:
           api-key: ${{ secrets.RUNLOOP_API_KEY }}
           source-type: tar
+          agent-version: 1.0.0
           path: agent.tar
 
   deploy-with-exclusions:
@@ -128,6 +131,7 @@ jobs:
         with:
           api-key: ${{ secrets.RUNLOOP_API_KEY }}
           source-type: tar
+          agent-version: 1.0.0
           path: agent.tar.gz
           object-ttl-days: 30
           is-public: false
@@ -150,4 +154,5 @@ jobs:
         with:
           api-key: ${{ secrets.RUNLOOP_API_KEY }}
           source-type: tar
+          agent-version: 1.0.0
           path: ./artifacts/agent.tar.gz

examples/single-file.yml

@@ -95,13 +95,11 @@ export function validateInputs(inputs: ActionInputs): void {
 }
 
 function validatePath(inputPath: string, sourceType: SourceType): void {
-  // Resolve path relative to workspace
-  const workspace = process.env.GITHUB_WORKSPACE;
-  if (!workspace) {
-    throw new Error('GITHUB_WORKSPACE environment variable is not set');
+  if (sourceType !== 'file' && sourceType !== 'tar') {
+    throw new Error(`validatePath is undefined when source-type is "${sourceType}": ${inputPath}`);
   }
 
-  const absolutePath = path.isAbsolute(inputPath) ? inputPath : path.join(workspace, inputPath);
+  const absolutePath = resolvePath(inputPath);
 
   // Check if path exists
   if (!fs.existsSync(absolutePath)) {
@@ -110,11 +108,8 @@ function validatePath(inputPath: string, sourceType: SourceType): void {
 
   // Validate based on source type
   const stats = fs.statSync(absolutePath);
-
-  if (sourceType === 'file' || sourceType === 'tar') {
-    if (!stats.isFile()) {
-      throw new Error(`Path must be a file when source-type is "${sourceType}": ${inputPath}`);
-    }
+  if (!stats.isFile()) {
+    throw new Error(`Path must be a file when source-type is "${sourceType}": ${inputPath}`);
   }
 }