update README

.github/workflows/licensed.yml

@@ -8,12 +8,12 @@ on:
   # Uncomment the below lines to run this workflow on pull requests and pushes
   # to the default branch. This is useful for checking licenses before merging
   # changes into the default branch.
-  # pull_request:
+  pull_request:
-  #   branches:
+    branches:
-  #     - main
+      - main
-  # push:
+  push:
-  #   branches:
+    branches:
-  #     - main
+      - main
   workflow_dispatch:
 
 permissions:

README.md

@@ -1,4 +1,4 @@
-# Create a GitHub Action Using TypeScript
+# AI Inference in GitHub Actions
 
 [![GitHub Super-Linter](https://github.com/actions/typescript-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
 ![CI](https://github.com/actions/typescript-action/actions/workflows/ci.yml/badge.svg)
@@ -6,238 +6,65 @@
 [![CodeQL](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml)
 [![Coverage](./badges/coverage.svg)](./badges/coverage.svg)
 
-Use this template to bootstrap the creation of a TypeScript action. :rocket:
+Use AI models from [GitHub Models](https://github.com/marketplace/models) in
-
+your actions.
-This template includes compilation support, tests, a validation workflow,
-publishing, and versioning guidance.
-
-If you are new, there's also a simpler introduction in the
-[Hello world JavaScript action repository](https://github.com/actions/hello-world-javascript-action).
-
-## Create Your Own Action
-
-To create your own action, you can use this repository as a template! Just
-follow the below instructions:
-
-1. Click the **Use this template** button at the top of the repository
-1. Select **Create a new repository**
-1. Select an owner and name for your new repository
-1. Click **Create repository**
-1. Clone your new repository
-
-> [!IMPORTANT]
->
-> Make sure to remove or update the [`CODEOWNERS`](./CODEOWNERS) file! For
-> details on how to use this file, see
-> [About code owners](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
-
-## Initial Setup
-
-After you've cloned the repository to your local machine or codespace, you'll
-need to perform some initial setup steps before you can develop your action.
-
-> [!NOTE]
->
-> You'll need to have a reasonably modern version of
-> [Node.js](https://nodejs.org) handy (20.x or later should work!). If you are
-> using a version manager like [`nodenv`](https://github.com/nodenv/nodenv) or
-> [`fnm`](https://github.com/Schniz/fnm), this template has a `.node-version`
-> file at the root of the repository that can be used to automatically switch to
-> the correct version when you `cd` into the repository. Additionally, this
-> `.node-version` file is used by GitHub Actions in any `actions/setup-node`
-> actions.
-
-1. :hammer_and_wrench: Install the dependencies
-
-   ```bash
-   npm install
-   ```
-
-1. :building_construction: Package the TypeScript for distribution
-
-   ```bash
-   npm run bundle
-   ```
-
-1. :white_check_mark: Run the tests
-
-   ```bash
-   $ npm test
-
-   PASS  ./index.test.js
-     ✓ throws invalid number (3ms)
-     ✓ wait 500 ms (504ms)
-     ✓ test runs (95ms)
-
-   ...
-   ```
-
-## Update the Action Metadata
-
-The [`action.yml`](action.yml) file defines metadata about your action, such as
-input(s) and output(s). For details about this file, see
-[Metadata syntax for GitHub Actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions).
-
-When you copy this repository, update `action.yml` with the name, description,
-inputs, and outputs for your action.
-
-## Update the Action Code
-
-The [`src/`](./src/) directory is the heart of your action! This contains the
-source code that will be run when your action is invoked. You can replace the
-contents of this directory with your own code.
-
-There are a few things to keep in mind when writing your action code:
-
-- Most GitHub Actions toolkit and CI/CD operations are processed asynchronously.
-  In `main.ts`, you will see that the action is run in an `async` function.
-
-  ```javascript
-  import * as core from '@actions/core'
-  //...
-
-  async function run() {
-    try {
-      //...
-    } catch (error) {
-      core.setFailed(error.message)
-    }
-  }
-  ```
-
-  For more information about the GitHub Actions toolkit, see the
-  [documentation](https://github.com/actions/toolkit/blob/master/README.md).
-
-So, what are you waiting for? Go ahead and start customizing your action!
-
-1. Create a new branch
-
-   ```bash
-   git checkout -b releases/v1
-   ```
-
-1. Replace the contents of `src/` with your action code
-1. Add tests to `__tests__/` for your source code
-1. Format, test, and build the action
-
-   ```bash
-   npm run all
-   ```
-
-   > This step is important! It will run [`rollup`](https://rollupjs.org/) to
-   > build the final JavaScript action code with all dependencies included. If
-   > you do not run this step, your action will not work correctly when it is
-   > used in a workflow.
-
-1. (Optional) Test your action locally
-
-   The [`@github/local-action`](https://github.com/github/local-action) utility
-   can be used to test your action locally. It is a simple command-line tool
-   that "stubs" (or simulates) the GitHub Actions Toolkit. This way, you can run
-   your TypeScript action locally without having to commit and push your changes
-   to a repository.
-
-   The `local-action` utility can be run in the following ways:
-
-   - Visual Studio Code Debugger
-
-     Make sure to review and, if needed, update
-     [`.vscode/launch.json`](./.vscode/launch.json)
-
-   - Terminal/Command Prompt
-
-     ```bash
-     # npx @github/local action <action-yaml-path> <entrypoint> <dotenv-file>
-     npx @github/local-action . src/main.ts .env
-     ```
-
-   You can provide a `.env` file to the `local-action` CLI to set environment
-   variables used by the GitHub Actions Toolkit. For example, setting inputs and
-   event payload data used by your action. For more information, see the example
-   file, [`.env.example`](./.env.example), and the
-   [GitHub Actions Documentation](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables).
-
-1. Commit your changes
-
-   ```bash
-   git add .
-   git commit -m "My first action is ready!"
-   ```
-
-1. Push them to your repository
-
-   ```bash
-   git push -u origin releases/v1
-   ```
-
-1. Create a pull request and get feedback on your action
-1. Merge the pull request into the `main` branch
-
-Your action is now published! :rocket:
-
-For information about versioning your action, see
-[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-in the GitHub Actions toolkit.
-
-## Validate the Action
-
-You can now validate the action by referencing it in a workflow file. For
-example, [`ci.yml`](./.github/workflows/ci.yml) demonstrates how to reference an
-action in the same repository.
-
-```yaml
-steps:
-  - name: Checkout
-    id: checkout
-    uses: actions/checkout@v4
-
-  - name: Test Local Action
-    id: test-action
-    uses: ./
-    with:
-      milliseconds: 1000
-
-  - name: Print Output
-    id: output
-    run: echo "${{ steps.test-action.outputs.time }}"
-```
-
-For example workflow runs, check out the
-[Actions tab](https://github.com/actions/typescript-action/actions)! :rocket:
 
 ## Usage
 
-After testing, you can create version tag(s) that developers can use to
+Create a workflow to use the AI inference action:
-reference different stable versions of your action. For more information, see
-[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-in the GitHub Actions toolkit.
-
-To include the action in a workflow in another repository, you can use the
-`uses` syntax with the `@` symbol to reference a specific branch, tag, or commit
-hash.
 
 ```yaml
 steps:
-  - name: Checkout
-    id: checkout
-    uses: actions/checkout@v4
-
   - name: Test Local Action
-    id: test-action
+    id: inference
-    uses: actions/typescript-action@v1 # Commit with the `v1` tag
+    uses: actions/ai-inference@v1
     with:
-      milliseconds: 1000
+      prompt: 'Hello!'
 
   - name: Print Output
     id: output
-    run: echo "${{ steps.test-action.outputs.time }}"
+    run: echo "${{ steps.test-action.outputs.response }}"
+```
+
+## Inputs
+
+Various inputs are defined in [`action.yml`](action.yml) to let you configure
+the action:
+
+| Name         | Description                                                                                                                           | Default                              |
+| ------------ | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
+| `token`      | Token to use for inference. Typically the GITHUB_TOKEN secret                                                                         | `github.token`                       |
+| `prompt`     | The prompt to send to the model                                                                                                       | N/A                                  |
+| `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` |
+| `max_tokens` | The max number of tokens to generate                                                                                                  | 200                                  |
+
+## Outputs
+
+The AI inference action provides the following outputs:
+
+| Name       | Description                 |
+| ---------- | --------------------------- |
+| `response` | The response from the model |
+
+## Required Permissions
+
+In order to run inference with GitHub Models, the GitHub AI inference action
+requires `models` permissions.
+
+```yml
+permissions:
+  contents: read
+  models: read
 ```
 
 ## Publishing a New Release
 
 This project includes a helper script, [`script/release`](./script/release)
 designed to streamline the process of tagging and pushing new releases for
-GitHub Actions.
+GitHub Actions. For more information, see
+[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
+in the GitHub Actions toolkit.
 
 GitHub Actions allows users to select a specific version of the action to use,
 based on release tags. This script simplifies this process by performing the
@@ -260,47 +87,6 @@ following steps:
    to create a new release in GitHub so users can easily reference the new tags
    in their workflows.
 
-## Dependency License Management
+## Contributions
 
-This template includes a GitHub Actions workflow,
+Contributions are welcome! See the [Contributor's Guide](CONTRIBUTING.md).
-[`licensed.yml`](./.github/workflows/licensed.yml), that uses
-[Licensed](https://github.com/licensee/licensed) to check for dependencies with
-missing or non-compliant licenses. This workflow is initially disabled. To
-enable the workflow, follow the below steps.
-
-1. Open [`licensed.yml`](./.github/workflows/licensed.yml)
-1. Uncomment the following lines:
-
-   ```yaml
-   # pull_request:
-   #   branches:
-   #     - main
-   # push:
-   #   branches:
-   #     - main
-   ```
-
-1. Save and commit the changes
-
-Once complete, this workflow will run any time a pull request is created or
-changes pushed directly to `main`. If the workflow detects any dependencies with
-missing or non-compliant licenses, it will fail the workflow and provide details
-on the issue(s) found.
-
-### Updating Licenses
-
-Whenever you install or update dependencies, you can use the Licensed CLI to
-update the licenses database. To install Licensed, see the project's
-[Readme](https://github.com/licensee/licensed?tab=readme-ov-file#installation).
-
-To update the cached licenses, run the following command:
-
-```bash
-licensed cache
-```
-
-To check the status of cached licenses, run the following command:
-
-```bash
-licensed status
-```

action.yml

@@ -13,6 +13,18 @@ inputs:
     description: Your input description here
     required: true
     default: ''
+  model:
+    description: The model to use
+    required: false
+    default: 'gpt-4o'
+  endpoint:
+    description: The endpoint to use
+    required: false
+    default: 'https://models.github.ai/inference'
+  max_tokens:
+    description: The maximum number of tokens to generate
+    required: false
+    default: '200'
 
 # Define your outputs here.
 outputs:

badges/coverage.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="116" height="20" role="img" aria-label="Coverage: 88.88%"><title>Coverage: 88.88%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="116" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="63" height="20" fill="#555"/><rect x="63" width="53" height="20" fill="#dfb317"/><rect width="116" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="325" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="530">Coverage</text><text x="325" y="140" transform="scale(.1)" fill="#fff" textLength="530">Coverage</text><text aria-hidden="true" x="885" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">88.88%</text><text x="885" y="140" transform="scale(.1)" fill="#fff" textLength="430">88.88%</text></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" width="116" height="20" role="img" aria-label="Coverage: 89.47%"><title>Coverage: 89.47%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="116" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="63" height="20" fill="#555"/><rect x="63" width="53" height="20" fill="#dfb317"/><rect width="116" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="325" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="530">Coverage</text><text x="325" y="140" transform="scale(.1)" fill="#fff" textLength="530">Coverage</text><text aria-hidden="true" x="885" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">89.47%</text><text x="885" y="140" transform="scale(.1)" fill="#fff" textLength="430">89.47%</text></g></svg>

dist/index.js

@@ -33560,12 +33560,13 @@ async function run() {
             throw new Error('prompt is not set');
         }
         const systemPrompt = coreExports.getInput('system_prompt');
-        const modelName = coreExports.getInput('model_name') || 'gpt-4o';
+        const modelName = coreExports.getInput('model');
+        const maxTokens = parseInt(coreExports.getInput('max_tokens'), 10);
         const token = process.env['GITHUB_TOKEN'];
         if (token === undefined) {
             throw new Error('GITHUB_TOKEN is not set');
         }
-        const endpoint = 'https://models.inference.ai.azure.com';
+        const endpoint = coreExports.getInput('endpoint');
         const client = createClient(endpoint, new AzureKeyCredential(token));
         const response = await client.path('/chat/completions').post({
             body: {
@@ -33578,7 +33579,7 @@ async function run() {
                 ],
                 temperature: 1.0,
                 top_p: 1.0,
-                max_tokens: 1000,
+                max_tokens: maxTokens,
                 model: modelName
             }
         });

src/main.ts

@@ -15,13 +15,14 @@ export async function run(): Promise<void> {
     }
 
     const systemPrompt: string = core.getInput('system_prompt')
-    const modelName = core.getInput('model_name') || 'gpt-4o'
+    const modelName: string = core.getInput('model')
+    const maxTokens: number = parseInt(core.getInput('max_tokens'), 10)
 
     const token = process.env['GITHUB_TOKEN']
     if (token === undefined) {
       throw new Error('GITHUB_TOKEN is not set')
     }
-    const endpoint = 'https://models.inference.ai.azure.com'
+    const endpoint = core.getInput('endpoint')
 
     const client = ModelClient(endpoint, new AzureKeyCredential(token))
 
@@ -36,7 +37,7 @@ export async function run(): Promise<void> {
         ],
         temperature: 1.0,
         top_p: 1.0,
-        max_tokens: 1000,
+        max_tokens: maxTokens,
         model: modelName
       }
     })