Documentation
¶
Index ¶
Constants ¶
const AgentJobName = "agent"
const AgentOutputArtifactName = "agent_output.json"
const CLIExtensionPrefix = "gh aw"
CLIExtensionPrefix is the prefix used in user-facing output to refer to the CLI extension
const DefaultMCPRegistryURL = "https://api.mcp.github.com/v0"
DefaultMCPRegistryURL is the default MCP registry URL
const ExpressionBreakThreshold = 100
ExpressionBreakThreshold is the threshold for breaking long lines at logical points
const MaxExpressionLineLength = 120
MaxExpressionLineLength is the maximum length for a single line expression before breaking into multiline
const SafeOutputArtifactName = "safe_output.jsonl"
Variables ¶
var AgenticEngines = []string{"claude", "codex", "copilot"}
var AllowedExpressions = []string{ "github.event.after", "github.event.before", "github.event.check_run.id", "github.event.check_suite.id", "github.event.comment.id", "github.event.deployment.id", "github.event.deployment_status.id", "github.event.head_commit.id", "github.event.installation.id", "github.event.issue.number", "github.event.label.id", "github.event.milestone.id", "github.event.organization.id", "github.event.page.id", "github.event.project.id", "github.event.project_card.id", "github.event.project_column.id", "github.event.pull_request.number", "github.event.release.assets[0].id", "github.event.release.id", "github.event.release.tag_name", "github.event.repository.id", "github.event.review.id", "github.event.review_comment.id", "github.event.sender.id", "github.event.workflow_run.id", "github.event.workflow_run.conclusion", "github.event.workflow_run.html_url", "github.event.workflow_run.head_sha", "github.event.workflow_run.run_number", "github.event.workflow_run.event", "github.event.workflow_run.status", "github.actor", "github.job", "github.owner", "github.repository", "github.run_id", "github.run_number", "github.server_url", "github.workflow", "github.workspace", } // needs., steps. already allowed
AllowedExpressions contains the GitHub Actions expressions that can be used in workflow markdown content see https://docs.github.com/en/actions/reference/workflows-and-actions/contexts#github-context
var DefaultAllowedDomains = []string{"localhost", "localhost:*", "127.0.0.1", "127.0.0.1:*"}
DefaultAllowedDomains defines the default localhost domains with port variations that are always allowed for Playwright browser automation
var DefaultBashTools = []string{
"echo",
"ls",
"pwd",
"cat",
"head",
"tail",
"grep",
"wc",
"sort",
"uniq",
"date",
}
DefaultBashTools defines basic bash commands that should be available by default when bash is enabled
var DefaultGitHubTools = []string{
"download_workflow_run_artifact",
"get_job_logs",
"get_workflow_run",
"get_workflow_run_logs",
"get_workflow_run_usage",
"list_workflow_jobs",
"list_workflow_run_artifacts",
"list_workflow_runs",
"list_workflows",
"get_code_scanning_alert",
"list_code_scanning_alerts",
"get_me",
"get_dependabot_alert",
"list_dependabot_alerts",
"get_discussion",
"get_discussion_comments",
"list_discussion_categories",
"list_discussions",
"get_issue",
"get_issue_comments",
"list_issues",
"search_issues",
"get_notification_details",
"list_notifications",
"search_orgs",
"get_pull_request",
"get_pull_request_comments",
"get_pull_request_diff",
"get_pull_request_files",
"get_pull_request_reviews",
"get_pull_request_status",
"list_pull_requests",
"search_pull_requests",
"get_commit",
"get_file_contents",
"get_tag",
"list_branches",
"list_commits",
"list_tags",
"search_code",
"search_repositories",
"get_secret_scanning_alert",
"list_secret_scanning_alerts",
"search_users",
"get_latest_release",
"get_pull_request_review_comments",
"get_release_by_tag",
"list_issue_types",
"list_releases",
"list_starred_repositories",
"list_sub_issues",
}
DefaultGitHubTools defines the default read-only GitHub MCP tools
var SafeWorkflowEvents = []string{"workflow_dispatch", "workflow_run", "schedule"}
SafeWorkflowEvents defines events that are considered safe and don't require permission checks
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files