Skip to content

[docs] Update documentation for features from 2026-01-24/25 #11787

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
pelikhan merged 1 commit into from
Jan 25, 2026
Merged

[docs] Update documentation for features from 2026-01-24/25 #11787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 37 additions & 0 deletions docs/src/content/docs/setup/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,43 @@ curl -sL https://raw.githubusercontent.com/githubnext/gh-aw/main/install-gh-aw.s

Installs to `~/.local/share/gh/extensions/gh-aw/gh-aw` and works with all `gh aw` commands. Supports Linux, macOS, FreeBSD, and Windows.

### GitHub Actions Setup Action

Install the CLI in GitHub Actions workflows using the `setup-cli` action:

``````yaml wrap
- name: Install gh-aw CLI
uses: githubnext/gh-aw/actions/setup-cli@main
with:
version: v0.37.18
``````

The action automatically installs the specified version with checksum verification and platform detection. Useful for CI/CD pipelines, workflow testing, and automation scripts.

**Features:**
- Version validation against GitHub releases
- SHA256 checksum verification for security
- Automatic platform and architecture detection
- Fallback installation methods for reliability
- Works on Linux, macOS, Windows, and FreeBSD

**Example with verification:**

``````yaml wrap
- name: Install gh-aw CLI
id: install
uses: githubnext/gh-aw/actions/setup-cli@main
with:
version: v0.37.18

- name: Verify installation
run: |
gh aw version
echo "Installed: ${{ steps.install.outputs.installed-version }}"
``````

See the [setup-cli action README](https://github.com/githubnext/gh-aw/blob/main/actions/setup-cli/README.md) for complete documentation and examples.

### GitHub Enterprise Server Support

Configure for GitHub Enterprise Server deployments:
Expand Down
41 changes: 41 additions & 0 deletions docs/src/content/docs/troubleshooting/common-issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,47 @@ mcp-servers:
API_KEY: "${{ secrets.MCP_API_KEY }}"
```

### Deprecated `mode` Field in Custom MCP Servers

**Error Message:**

```text
Additional property mode is not allowed
```

**Cause:** The `mode` field was removed from custom MCP server configurations. This field was previously used to specify the MCP server transport type but has been deprecated.

**Solution:** Remove the `mode` field from your custom MCP server configurations. The transport type is now automatically detected based on the configuration:

```yaml wrap
# Before (deprecated)
mcp-servers:
my-server:
command: "npx"
args: ["@myorg/mcp-server"]
mode: "stdio" # Remove this line
allowed: ["*"]

# After (correct)
mcp-servers:
my-server:
command: "npx"
args: ["@myorg/mcp-server"]
allowed: ["*"]
```

**Automatic Migration:** Run `gh aw fix --write` to automatically remove deprecated `mode` fields from all workflow files:

```bash wrap
gh aw fix --write
```

The `fix` command applies the `mcp-mode-to-type` codemod which removes the `mode` field while preserving all other configuration.

> [!NOTE]
> GitHub MCP Server Configuration
> The `mode` field is still valid for the GitHub MCP server (`tools.github.mode`) to choose between `local` (Docker-based) and `remote` (hosted) modes. This deprecation only affects custom MCP servers defined in the `mcp-servers:` section.

### Playwright Network Access Denied

Add blocked domains to the `allowed_domains` list:
Expand Down