read prompt from file and print output to file

Author: aiqiaoy

CONTRIBUTING.md

@@ -46,7 +46,7 @@ avoid having to include the `node_modules/` directory in the repository.
 1. Make your change, add tests, and make sure the tests still pass:
    `npm run test`
 1. Make sure your code is correctly formatted: `npm run format`
-1. Update `dist/index.js` using `npm run build`. This creates a single
+1. Update `dist/index.js` using `npm run bundle`. This creates a single
    JavaScript file that is used as an entrypoint for the action
 1. Push to your fork and [submit a pull request][pr]
 1. Pat yourself on the back and wait for your pull request to be reviewed and

README.md

@@ -34,6 +34,30 @@ jobs:
         run: echo "${{ steps.inference.outputs.response }}"
 ```
 
+### Using a Prompt File
+
+You can also provide a prompt file instead of an inline prompt:
+
+```yaml
+steps:
+  - name: Checkout repository
+    uses: actions/checkout@v4
+
+  - name: Run AI Inference with Prompt File
+    id: inference
+    uses: actions/ai-inference@v1
+    with:
+      prompt-file: './path/to/prompt.txt'
+
+  - name: Use Response File
+    run: |
+      echo "Response saved to: ${{ steps.inference.outputs.response-path }}"
+      cat "${{ steps.inference.outputs.response-path }}"
+```
+
+This is particularly useful for longer prompts or when you need to use the file
+path where the response is stored.
+
 ## Inputs
 
 Various inputs are defined in [`action.yml`](action.yml) to let you configure
@@ -43,6 +67,7 @@ the action:
 | --------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
 | `token`         | Token to use for inference. Typically the GITHUB_TOKEN secret                                                                         | `github.token`                       |
 | `prompt`        | The prompt to send to the model                                                                                                       | N/A                                  |
+| `prompt-file`   | Path to a file containing the prompt. If both `prompt` and `prompt-file` are provided, `prompt-file` takes precedence                 | `""`                                 |
 | `system-prompt` | The system prompt to send to the model                                                                                                | `""`                                 |
 | `model`         | The model to use for inference. Must be available in the [GitHub Models](https://github.com/marketplace?type=models) catalog          | `gpt-4o`                             |
 | `endpoint`      | The endpoint to use for inference. If you're running this as part of an org, you should probably use the org-specific Models endpoint | `https://models.github.ai/inference` |
@@ -52,9 +77,10 @@ the action:
 
 The AI inference action provides the following outputs:
 
-| Name       | Description                 |
-| ---------- | --------------------------- |
-| `response` | The response from the model |
+| Name            | Description                                                             |
+| --------------- | ----------------------------------------------------------------------- |
+| `response`      | The response from the model                                             |
+| `response-path` | The file path where the response is saved (useful for larger responses) |
 
 ## Required Permissions
 

__tests__/main.test.ts

@@ -7,7 +7,6 @@
  */
 import { jest } from '@jest/globals'
 import * as core from '../__fixtures__/core.js'
-
 const mockPost = jest.fn().mockImplementation(() => ({
   body: {
     choices: [
@@ -58,11 +57,21 @@ describe('main.ts', () => {
       'response',
       'Hello, user!'
     )
+
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'response-path',
+      expect.stringContaining('modelResponse.txt')
+    )
   })
 
   it('Sets a failed status', async () => {
-    // Clear the getInput mock and return an empty prompt
-    core.getInput.mockClear().mockReturnValueOnce('')
+    // Clear the getInput mock and simulate no prompt or prompt-file input
+    core.getInput.mockImplementation((name) => {
+      if (name === 'prompt') return ''
+      if (name === 'prompt_file') return ''
+      return ''
+    })
 
     await run()
 

action.yml

@@ -11,7 +11,11 @@ branding:
 inputs:
   prompt:
     description: The prompt for the model
-    required: true
+    required: false
+    default: ''
+  prompt-file:
+    description: Path to a file containing the prompt
+    required: false
     default: ''
   model:
     description: The model to use
@@ -38,6 +42,8 @@ inputs:
 outputs:
   response:
     description: The response from the model
+  response-path:
+    description: The file path where the response is saved
 
 runs:
   using: node20

dist/index.js

@@ -1,6 +1,11 @@
 import * as core from '@actions/core'
 import ModelClient, { isUnexpected } from '@azure-rest/ai-inference'
 import { AzureKeyCredential } from '@azure/core-auth'
+import * as fs from 'fs'
+import * as os from 'os'
+import * as path from 'path'
+
+const RESPONSE_FILE = 'modelResponse.txt'
 
 /**
  * The main function for the action.
@@ -9,7 +14,16 @@ import { AzureKeyCredential } from '@azure/core-auth'
  */
 export async function run(): Promise<void> {
   try {
-    const prompt: string = core.getInput('prompt')
+    const promptFile: string = core.getInput('prompt-file')
+    let prompt: string = core.getInput('prompt')
+
+    if (promptFile !== undefined && promptFile !== '') {
+      if (!fs.existsSync(promptFile)) {
+        throw new Error(`Prompt file not found: ${promptFile}`)
+      }
+      prompt = fs.readFileSync(promptFile, 'utf-8')
+    }
+
     if (prompt === undefined || prompt === '') {
       throw new Error('prompt is not set')
     }
@@ -60,6 +74,14 @@ export async function run(): Promise<void> {
 
     // Set outputs for other workflow steps to use
     core.setOutput('response', modelResponse || '')
+
+    // Save the response to a file in case the response overflow the output limit
+    const responseFilePath = path.join(tempDir(), RESPONSE_FILE)
+    core.setOutput('response-path', responseFilePath)
+
+    if (modelResponse && modelResponse !== '') {
+      fs.writeFileSync(responseFilePath, modelResponse, 'utf-8')
+    }
   } catch (error) {
     // Fail the workflow run if an error occurs
     if (error instanceof Error) {
@@ -69,3 +91,8 @@ export async function run(): Promise<void> {
     }
   }
 }
+
+function tempDir(): string {
+  const tempDirectory = process.env['RUNNER_TEMP'] || os.tmpdir()
+  return tempDirectory
+}