You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
// Return error as-is without additional formatting
@@ -701,6 +703,7 @@ Use "` + string(constants.CLIExtensionPrefix) + ` help all" to show help for all
701
703
compileCmd.Flags().Bool("approve", false, "Approve all safe update changes. When strict mode is active (the default), the compiler emits warnings for new restricted secrets or unapproved action additions/removals not present in the existing gh-aw-manifest. Use this flag to approve and skip safe update enforcement")
702
704
compileCmd.Flags().Bool("validate-images", false, "Require Docker to be available for container image validation. Without this flag, container image validation is silently skipped when Docker is not installed or the daemon is not running")
703
705
compileCmd.Flags().String("prior-manifest-file", "", "Path to a JSON file containing pre-cached gh-aw-manifests (map[lockFile]*GHAWManifest); used by the MCP server to supply a tamper-proof manifest baseline captured at startup")
706
+
compileCmd.Flags().Bool("ghes", false, "Enable GitHub Enterprise Server (GHES) compatibility mode: emit upload-artifact@v3 and download-artifact@v3 instead of the latest v7/v8 which are not supported on GHES. Overrides the aw.json ghes field")
|[Dev](https://github.com/github/gh-aw/blob/main/.github/workflows/dev.md)| pi |[](https://github.com/github/gh-aw/actions/workflows/dev.lock.yml)|`daily around 9:00`| - |
@@ -146,6 +149,7 @@ These are experimental agentic workflows used by the GitHub Next team to learn,
description: Configure GitHub Agentic Workflows for GitHub Enterprise Server (GHES) and GitHub Enterprise Cloud (GHEC), including artifact compatibility and CLI setup.
4
+
sidebar:
5
+
order: 51
6
+
---
7
+
8
+
# Enterprise Configuration
9
+
10
+
This page covers configuration options specific to GitHub Enterprise Server (GHES) and GitHub Enterprise Cloud (GHEC) deployments.
11
+
12
+
## GitHub Enterprise Server (GHES) Compatibility
13
+
14
+
### Artifact Compatibility Mode
15
+
16
+
GHES instances running versions that predate `@actions/artifact` v2.0.0 support cannot use `actions/upload-artifact@v4+` or `actions/download-artifact@v4+`. Attempting to run compiled workflows on these instances produces a `GHESNotSupportedError`.
17
+
18
+
gh-aw includes a GHES compatibility mode that instructs the compiler to emit `upload-artifact@v3.2.2` and `download-artifact@v3.1.0` instead of the latest v4+ versions.
19
+
20
+
#### Enable via `aw.json` (recommended)
21
+
22
+
Set `ghes: true` in `.github/workflows/aw.json` to apply GHES compatibility to every workflow compiled in the repository:
23
+
24
+
```json
25
+
{
26
+
"ghes": true
27
+
}
28
+
```
29
+
30
+
#### Auto-detection with `gh aw init`
31
+
32
+
Running `gh aw init` inside a GHES repository automatically detects the deployment and writes `ghes: true` to `.github/workflows/aw.json`. No manual configuration is required.
33
+
34
+
#### Enable via CLI flag
35
+
36
+
Pass `--ghes` to `gh aw compile` for a one-off compilation without modifying `aw.json`:
37
+
38
+
```bash
39
+
gh aw compile --ghes my-workflow.md
40
+
```
41
+
42
+
> [!NOTE]
43
+
> The `--ghes` flag only affects the current compilation. Use `aw.json` to apply GHES compatibility permanently across all workflows in the repository.
44
+
45
+
## GitHub Enterprise Server CLI Setup
46
+
47
+
For `gh` CLI configuration, host authentication, and `GH_HOST` setup on GHES, see [GitHub Enterprise Server Support](/gh-aw/setup/cli/#github-enterprise-server-support) in the CLI reference.
48
+
49
+
## Copilot Engine on GHES
50
+
51
+
For Copilot-specific prerequisites, licensing requirements, and firewall configuration on GHES, see [Copilot Engine Prerequisites on GHES](/gh-aw/troubleshooting/common-issues/#copilot-engine-prerequisites-on-ghes).
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/faq.md
+22Lines changed: 22 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -425,6 +425,28 @@ macOS runners (`macos-*`) are not currently supported in agentic workflows. Agen
425
425
426
426
Use `ubuntu-latest` (the default) or another Linux-based runner instead. For tasks that genuinely require macOS-specific tooling, consider running those steps in a regular GitHub Actions job that coordinates with your agentic workflow.
427
427
428
+
### Can I use agentic workflows on GitHub Enterprise Server (GHES)?
429
+
430
+
Yes, but you may need to enable GHES compatibility mode to avoid artifact errors. GHES instances that predate `@actions/artifact` v2.0.0 support cannot run `actions/upload-artifact@v4+` or `actions/download-artifact@v4+`. On those instances, compiled workflows fail with a `GHESNotSupportedError` because the compiler emits v4+ artifact actions by default.
431
+
432
+
Enable GHES compatibility mode so the compiler emits `upload-artifact@v3.2.2` and `download-artifact@v3.1.0` instead:
433
+
434
+
**`aw.json` (recommended — applies to all workflows in the repository):**
435
+
436
+
```json
437
+
{
438
+
"ghes": true
439
+
}
440
+
```
441
+
442
+
**`--ghes` flag (one-off compilation):**
443
+
444
+
```bash
445
+
gh aw compile --ghes my-workflow.md
446
+
```
447
+
448
+
Running `gh aw init` inside a GHES repository automatically detects the deployment and writes `ghes: true` to `.github/workflows/aw.json` for you. For `gh` CLI host setup and Copilot prerequisites on GHES, see [Enterprise Configuration](/gh-aw/reference/enterprise-configuration/).
449
+
428
450
### I'm not using a supported AI Engine (coding agent). What should I do?
429
451
430
452
If you want to use a coding agent that isn't currently supported (Copilot, Claude, Codex, Gemini, or Crush), you can contribute support to the [gh-aw repository](https://github.com/github/gh-aw), or open an issue describing your use case. See [AI Engines](/gh-aw/reference/engines/).
Copy file name to clipboardExpand all lines: pkg/cli/compile_config.go
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,7 @@ type CompileConfig struct {
33
33
Approvebool// Approve all safe update changes, skipping safe update enforcement regardless of strict mode setting.
34
34
ValidateImagesbool// Require Docker to be available for container image validation (fail instead of skipping when Docker is unavailable)
35
35
PriorManifestFilestring// Path to a JSON file containing pre-cached manifests (map[lockFile]*GHAWManifest) collected at MCP server startup; takes precedence over git HEAD / filesystem reads for safe update enforcement
0 commit comments