Merge pull request #15 from actions/aiqiaoy/read-prompt-from-file

read prompt from file and print output to file

Author: aiqiaoy

.github/workflows/ci.yml

@@ -67,3 +67,28 @@ jobs:
       - name: Print Output
         id: output
         run: echo "${{ steps.test-action.outputs.response }}"
+
+  test-action-prompt-file:
+    name: GitHub Actions Test with Prompt File
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v4
+
+      - name: Create Prompt File
+        run: echo "hello" > prompt.txt
+
+      - name: Test Local Action with Prompt File
+        id: test-action-prompt-file
+        uses: ./
+        with:
+          prompt-file: prompt.txt
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+
+      - name: Print Output
+        run: |
+          echo "Response saved to: ${{ steps.test-action-prompt-file.outputs.response-file }}"
+          cat "${{ steps.test-action-prompt-file.outputs.response-file }}"

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,37 @@ 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: Run AI Inference with Prompt File
+    id: inference
+    uses: actions/ai-inference@v1
+    with:
+      prompt-file: './path/to/prompt.txt'
+```
+
+### Read output from file instead of output
+
+This can be useful when model response exceeds actions output limit
+
+```yaml
+steps:
+  - name: Test Local Action
+    id: inference
+    uses: actions/ai-inference@v1
+    with:
+      prompt: 'Hello!'
+
+  - name: Use Response File
+    run: |
+      echo "Response saved to: ${{ steps.inference.outputs.response-file }}"
+      cat "${{ steps.inference.outputs.response-file }}"
+```
+
 ## Inputs
 
 Various inputs are defined in [`action.yml`](action.yml) to let you configure
@@ -43,6 +74,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 +84,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-file` | 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: [
@@ -29,44 +28,81 @@ jest.unstable_mockModule('@azure-rest/ai-inference', () => ({
   isUnexpected: jest.fn(() => false)
 }))
 
+const mockExistsSync = jest.fn().mockReturnValue(true)
+const mockReadFileSync = jest.fn().mockReturnValue('Hello, AI!')
+
+jest.unstable_mockModule('fs', () => ({
+  existsSync: mockExistsSync,
+  readFileSync: mockReadFileSync
+}))
+
 jest.unstable_mockModule('@actions/core', () => core)
 
 // The module being tested should be imported dynamically. This ensures that the
 // mocks are used in place of any actual dependencies.
 const { run } = await import('../src/main.js')
 
 describe('main.ts', () => {
-  beforeEach(() => {
+  it('Sets the response output', async () => {
     // Set the action's inputs as return values from core.getInput().
     core.getInput.mockImplementation((name) => {
       if (name === 'prompt') return 'Hello, AI!'
       if (name === 'system_prompt') return 'You are a test assistant.'
       if (name === 'model_name') return 'gpt-4o'
       return ''
     })
-  })
-
-  afterEach(() => {
-    jest.resetAllMocks()
-  })
 
-  it('Sets the response output', async () => {
     await run()
 
     expect(core.setOutput).toHaveBeenNthCalledWith(
       1,
       'response',
       'Hello, user!'
     )
+
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'response-file',
+      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()
 
     // Verify that the action was marked as failed.
     expect(core.setFailed).toHaveBeenNthCalledWith(1, 'prompt is not set')
   })
+
+  it('uses prompt-file', async () => {
+    const promptFile = 'prompt.txt'
+    core.getInput.mockImplementation((name) => {
+      if (name === 'prompt-file') return promptFile
+      if (name === 'system-prompt') return 'You are a test assistant.'
+      if (name === 'model-name') return 'gpt-4o'
+      return ''
+    })
+
+    await run()
+
+    expect(mockExistsSync).toHaveBeenCalledWith(promptFile)
+    expect(mockReadFileSync).toHaveBeenCalledWith(promptFile, 'utf-8')
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      1,
+      'response',
+      'Hello, user!'
+    )
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'response-file',
+      expect.stringContaining('modelResponse.txt')
+    )
+  })
 })

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-file:
+    description: The file path where the response is saved
 
 runs:
   using: node20