Skip to content

Align development prerequisite guidance #1902

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

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Align development prerequisite guidance #1902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a64bdc6
Initial plan
Copilot Aug 25, 2026
9647d74
Align development prerequisite documentation
Copilot Aug 25, 2026
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
4 changes: 3 additions & 1 deletion DEVELOPING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Development Guide

This page is the source of truth for repository prerequisites. See the [docs-site Developing guide](docs/developing.md) for the equivalent onboarding page.

## Repository Structure

| Directory | What | Docs |
Expand All @@ -16,7 +18,7 @@ Internal-only workflows (e.g., `upgrade-check.md`, `workflow-patrol.md`, `ci.yml
- [GitHub CLI (`gh`)](https://cli.github.com/) — installed automatically by `make setup` on Linux, but must be pre-installed on macOS
- `curl` or `wget` — used to download the official gh-aw release compiler binary

Verify with:
If building the compiler from source, verify Go with:

```bash
go version
Expand Down
7 changes: 5 additions & 2 deletions docs/developing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Developing

> This page mirrors the repository [Development Guide](https://github.com/elastic/ai-github-actions/blob/main/DEVELOPING.md), which is the source of truth for prerequisites.

## Repository structure

| Directory | What | Docs |
Expand All @@ -12,10 +14,11 @@ Internal-only workflows (e.g., `upgrade-check.md`, `workflow-patrol.md`, `ci.yml

## Prerequisites

- [Go](https://go.dev/dl/) — required by `make setup` to build the `gh-aw` compiler
- [Go](https://go.dev/dl/) — optional; only needed for non-release gh-aw compiler builds
- [GitHub CLI (`gh`)](https://cli.github.com/) — installed automatically by `make setup` on Linux, but must be pre-installed on macOS
- `curl` or `wget` — used to download the official gh-aw release compiler binary

Verify with:
If building the compiler from source, verify Go with:

```bash
go version
Expand Down