Skip to content

Weekly editors health check: discover editors dynamically from docs #17586

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 2 commits into from
Feb 21, 2026
+17 −14
Merged

Weekly editors health check: discover editors dynamically from docs #17586

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddf2bd4
Initial plan
Copilot Feb 21, 2026
d279300
feat: update weekly editors health check to scan editors.mdx for edit…
Copilot Feb 21, 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
31 changes: 17 additions & 14 deletions .github/workflows/weekly-editors-health-check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,19 +46,25 @@ Monitor the health of all workflow editors listed in the documentation and keep

## Editors to Check

The editors are documented in `docs/src/content/docs/reference/editors.mdx`. Check each of the following URLs:

| Editor | URL |
|--------|-----|
| Compiler Playground | https://github.github.com/gh-aw/editor/ |
| Agentic Prompt Generator | https://ashleywolf.github.io/agentic-prompt-generator/ |
| Graphical Workflow Editor | https://mossaka.github.io/gh-aw-editor-visualizer/ |
The editors are documented in `docs/src/content/docs/reference/editors.mdx`.

## Process

### Step 0: Discover Editors

Read the file `docs/src/content/docs/reference/editors.mdx` using the `cat` command to extract the list of editors to inspect. Parse the file sequentially top to bottom:

1. Track the most recent `###` heading encountered — this is the editor name for all `<LinkButton>` elements that follow it until the next heading.
2. For each `<LinkButton href="...">` element found, record the `href` value as the editor URL.
3. Derive the editor-id by converting the `###` heading to lowercase kebab-case (e.g., "Compiler Playground" → `compiler-playground`).
4. For any `href` that is not an absolute `https://` URL (e.g., it uses template expressions like `${import.meta.env.BASE_URL}` or starts with `/`), resolve it relative to the documentation base URL `https://github.github.com/gh-aw/`. For example, `${import.meta.env.BASE_URL}editor/` resolves to `https://github.github.com/gh-aw/editor/`.
Comment on lines +58 to +60
Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Step 0 says to parse only <LinkButton href="..."> attributes, but editors.mdx currently uses MDX expression syntax for the built-in editor (<LinkButton href={${import.meta.env.BASE_URL}editor/}>). As written, this discovery step would miss Compiler Playground entirely. Update the instructions to also capture href={...} / template-literal forms (and not just quoted strings), and then apply the BASE_URL resolution rules to that extracted expression.

Suggested change
2. For each `<LinkButton href="...">` element found, record the `href` value as the editor URL.
3. Derive the editor-id by converting the `###` heading to lowercase kebab-case (e.g., "Compiler Playground" → `compiler-playground`).
4. For any `href` that is not an absolute `https://` URL (e.g., it uses template expressions like `${import.meta.env.BASE_URL}` or starts with `/`), resolve it relative to the documentation base URL `https://github.github.com/gh-aw/`. For example, `${import.meta.env.BASE_URL}editor/` resolves to `https://github.github.com/gh-aw/editor/`.
2. For each `<LinkButton>` element found, locate its `href` attribute and record its value as the editor URL. Support both plain-string attributes (`href="https://..."`) and MDX expression attributes (`href={...}`, including template literals such as ``href={`${import.meta.env.BASE_URL}editor/`}``); when using `cat`, treat the entire `href={...}` block (including backticks) as the raw href expression.
3. Derive the editor-id by converting the `###` heading to lowercase kebab-case (e.g., "Compiler Playground" → `compiler-playground`).
4. For any extracted `href` that is not an absolute `https://` URL (for example, it contains `${import.meta.env.BASE_URL}`, starts with `/`, or is a relative path), resolve it relative to the documentation base URL `https://github.github.com/gh-aw/`. In particular, when the href is an expression that includes `${import.meta.env.BASE_URL}` (e.g., ``href={`${import.meta.env.BASE_URL}editor/`}``), conceptually replace `${import.meta.env.BASE_URL}` with `https://github.github.com/gh-aw/` to obtain the final URL (e.g., `https://github.github.com/gh-aw/editor/`).

Copilot uses AI. Check for mistakes.
5. Build a working list of editors with: name, editor-id, and resolved URL.

Proceed with the full list of editors discovered in this step.

### Step 1: URL Availability Check

For each URL in the table above, verify that the page is reachable:
For each editor discovered in Step 0, verify that its URL is reachable:

1. Use `web_fetch` (or `curl -sS -o /dev/null -w "%{http_code}" <url>`) to perform an HTTP GET request.
Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The workflow frontmatter enables the web-fetch tool, but Step 1 instructs using web_fetch (underscore). This mismatch can cause the agent to call a non-existent tool name. Align the step text with the configured tool name (web-fetch).

Suggested change
1. Use `web_fetch` (or `curl -sS -o /dev/null -w "%{http_code}" <url>`) to perform an HTTP GET request.
1. Use `web-fetch` (or `curl -sS -o /dev/null -w "%{http_code}" <url>`) to perform an HTTP GET request.

Copilot uses AI. Check for mistakes.
2. Record the HTTP status code for each URL.
Expand All @@ -71,10 +77,7 @@ For each editor URL that responded with HTTP 200 in Step 1:

1. Use the Playwright MCP tool to navigate to the URL.
2. Wait for the page to fully load (wait for network idle).
3. Take a full-page screenshot and save it to `/tmp/gh-aw/editors/<editor-id>-screenshot.png` where `<editor-id>` is one of:
- `compiler-playground`
- `agentic-prompt-generator`
- `graphical-workflow-editor`
3. Take a full-page screenshot and save it to `/tmp/gh-aw/editors/<editor-id>-screenshot.png` where `<editor-id>` is the kebab-case id derived in Step 0.

### Step 3: Upload Screenshots as Assets

Expand Down Expand Up @@ -109,7 +112,7 @@ After updating the documentation file, use the `create-pull-request` safe output
- HTTP status (✅ 200 / ❌ <status code>)
- Embedded screenshot (if available)

Example body:
Example body (rows reflect whatever editors were discovered in Step 0):

```markdown
## Editor Health Report – <date>
Expand All @@ -118,7 +121,7 @@ Example body:
|--------|-----|--------|---------|
| Compiler Playground | https://github.github.com/gh-aw/editor/ | ✅ 200 | ![preview](<url>) |
| Agentic Prompt Generator | https://ashleywolf.github.io/agentic-prompt-generator/ | ✅ 200 | ![preview](<url>) |
| Graphical Workflow Editor | https://mossaka.github.io/gh-aw-editor-visualizer/ | ✅ 200 | ![preview](<url>) |
| ... | ... | ... | ... |
```

## Error Handling
Expand Down