Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# QA Instructions Action

[![CI](https://github.com/slifty/qa-instructions-action/actions/workflows/ci.yml/badge.svg)](https://github.com/slifty/qa-instructions-action/actions/workflows/ci.yml)
[![CI](https://github.com/BadIdeaFactory/qa-instructions-action/actions/workflows/ci.yml/badge.svg)](https://github.com/BadIdeaFactory/qa-instructions-action/actions/workflows/ci.yml)

A GitHub Action that automatically generates QA testing instructions for pull requests using AI. On each PR push, it gathers context about the changes and posts (or updates) a comment with structured testing instructions.

Expand All @@ -27,7 +27,7 @@ jobs:
qa-instructions:
runs-on: ubuntu-latest
steps:
- uses: slifty/qa-instructions-action@v1
- uses: BadIdeaFactory/qa-instructions-action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
```
Expand All @@ -53,7 +53,7 @@ jobs:
qa-instructions:
runs-on: ubuntu-latest
steps:
- uses: slifty/qa-instructions-action@v1
- uses: BadIdeaFactory/qa-instructions-action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
provider: anthropic
Expand Down Expand Up @@ -102,6 +102,36 @@ You can override the model with any model supported by the chosen provider.
- Things to watch for
4. Posts (or updates) the instructions as a PR comment, identified by a hidden HTML marker

## Troubleshooting

### GitHub Models returns 403 Forbidden

If you see a 403 error when using the `github-models` provider, GitHub Models may be disabled at the organization level. GitHub Models uses a hierarchical access control system:

1. **Enterprise level** — An enterprise owner must enable GitHub Models for the enterprise (if your organization is part of an enterprise)
2. **Organization level** — An organization owner must enable GitHub Models for the organization
3. **Workflow level** — Your workflow must declare `permissions: models: read` (already in the example above)

**To enable GitHub Models for your organization:**

An organization owner needs to:

1. Navigate to your organization's **Settings**
2. Go to **Code, planning, and automation** → **Models** → **Development**
3. Enable GitHub Models for the organization

**Alternative workaround:**

If you cannot enable GitHub Models at the organization level, switch to the Anthropic provider:

```yaml
- uses: BadIdeaFactory/qa-instructions-action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
provider: anthropic
anthropic-api-key: ${{ secrets.ANTHROPIC_API_KEY }}
```

## Development

### Setup
Expand Down
10 changes: 0 additions & 10 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/slifty/qa-instructions-action.git"
"url": "git+https://github.com/BadIdeaFactory/qa-instructions-action.git"
},
"license": "AGPL-3.0",
"dependencies": {
Expand Down
2 changes: 1 addition & 1 deletion src/comment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ function buildCommentBody(instructions: string): string {
instructions,
"",
"---",
"*Generated by [QA Instructions Action](https://github.com/slifty/qa-instructions-action)*",
"*Generated by [QA Instructions Action](https://github.com/BadIdeaFactory/qa-instructions-action)*",
].join("\n");
}

Expand Down