Skip to content

Support Model #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathro merged 2 commits into from
Aug 11, 2025
Merged

Support Model #2

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6bac09
Support Model
nathro Aug 11, 2025
87b2c5d
Update model example
nathro Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ Each example includes a complete workflow file that you can copy to your `.githu
| `pull_number` | The number of the pull request being described | Yes | `${{ github.event.pull_request.number }}` |
| `repo_name` | The full name (owner/repo) of the repository | Yes | `${{ github.repository }}` |
| `custom_guidelines` | Custom guidelines for PR descriptions (optional) | No | See [Custom Guidelines](#custom-guidelines) section |
| `model` | Optional model to use for generation | No | e.g. `gpt-4o`, `claude-3-5-sonnet`, etc. |
Copy link

@mtpauly mtpauly Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example should probably be a model that's publicly available (sonnet4 or gpt5)

Copy link
Collaborator Author

@nathro nathro Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, I forgot to check this. Will update.


Copy link

@github-actions github-actions bot Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice addition. To improve discoverability, consider adding a quick usage example that shows how to set model in the workflow, e.g. in one of the examples:

with:
  # ...existing inputs
  model: gpt-4o

This helps users understand exactly where/how to pass the new input.

## How It Works

Expand Down
6 changes: 5 additions & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ inputs:
custom_guidelines:
description: "Optional custom guidelines to include in PR description generation. Provide additional instructions or requirements specific to your project."
required: false
model:
description: "Optional model to use for generation. Passed directly to augment-agent."
required: false

runs:
using: "composite"
Expand All @@ -44,11 +47,12 @@ runs:
CUSTOM_GUIDELINES: ${{ inputs.custom_guidelines }}

- name: Run Augment Agent
uses: augmentcode/augment-agent@6f08f56902d6728a0ffbbb2004c136c06fec8104 # v0.1.0
uses: augmentcode/augment-agent@v0
with:
augment_session_auth: ${{ inputs.augment_session_auth }}
Copy link

@github-actions github-actions bot Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using a mutable tag (@v0) makes the workflow susceptible to supply‑chain issues if the tag is moved. Consider pinning to an immutable commit SHA and keeping a comment for readability, for example:

uses: augmentcode/augment-agent@<commit_sha> # v0

This preserves security while still signaling the intended major/minor version.

github_token: ${{ inputs.github_token }}
template_directory: "${{ github.action_path }}/templates"
pull_number: ${{ inputs.pull_number }}
repo_name: ${{ inputs.repo_name }}
custom_context: ${{ steps.custom_context.outputs.context }}
model: ${{ inputs.model }}
Loading