Skip to content

[instructions] Sync instruction files with release 0.80.6#40604

Merged
pelikhan merged 1 commit into
mainfrom
instructions-sync-imports-engine-fields-913ea3d9607aebcd
Jun 21, 2026
Merged

[instructions] Sync instruction files with release 0.80.6#40604
pelikhan merged 1 commit into
mainfrom
instructions-sync-imports-engine-fields-913ea3d9607aebcd

Conversation

@github-actions

@github-actions github-actions Bot commented Jun 21, 2026

Copy link
Copy Markdown
Contributor

Summary

Synchronises the syntax documentation under .github/aw/ with the current import schema and engine configuration options. Two changes are included: new frontmatter fields are documented for the agentic syntax reference, and the per-import-entry key surface is narrowed to remove keys that are not actually accepted on import entries.

Changes

.github/aw/syntax-agentic.md — new frontmatter fields documented

  • Documents max-turn-cache-misses: — the API proxy cache-miss budget, capping how many consecutive cache misses are allowed before the proxy blocks further requests (integer, default 5; maps to apiProxy.maxCacheMisses).
  • Documents permission-mode: — a Claude engine option controlling permission mode behaviour (auto | acceptEdits | plan | bypassPermissions; default acceptEdits, or auto when tools.edit is false).
  • Impact: Medium. Additive documentation; no runtime behaviour is changed.

.github/aw/syntax-tools-imports.md — import entry key surface narrowed

  • Removes env: and checkout: as valid per-import-entry keys.
  • Clarifies that only path/uses and with/inputs are accepted on an import entry.
  • Environment variables and checkout refs must now be set as top-level frontmatter inside the imported file.
  • Impact: High / Breaking. Workflows with env: or checkout: on import entries must be migrated.

Migration guide

Move per-entry env:/checkout: into the frontmatter of the imported file itself.

Generated by PR Description Updater for issue #40604 · 41.9 AIC · ⌖ 7.13 AIC · ⊞ 4.5K ·

- Remove unsupported per-import `env:`/`checkout:` keys (schema rejects
  them; parser only reads path/uses + inputs/with). Point to the
  imported-file top-level env/checkout merge instead.
- Document `max-turn-cache-misses` top-level frontmatter field.
- Document `engine.permission-mode` (claude).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor Author

Great automated maintenance run from the Instructions Janitor 🧹 — the three concrete fixes here (removing the invalid per-import env:/checkout: keys that would fail schema validation, and documenting the previously missing max-turn-cache-misses and engine.permission-mode fields) are exactly the kind of targeted accuracy corrections these instruction files need.

One mechanical flag from the checklist:

  • No test files changed — this is expected for a doc-only PR touching .github/aw/*.md; the tests: no signal is a checklist artifact and not a real gap here.

The description is thorough: every fix is traced back to a schema location or parser source, the size audit confirms all files remain under the 500-line target, and the duplication/accuracy checks are explicitly documented. This looks ready for a core team merge review.

Review the three changes in this Instructions Janitor PR and confirm each is accurate:
1. `.github/aw/syntax-tools-imports.md` — verify that per-import `env:` and `checkout:` keys are indeed rejected by `main_workflow_schema.json` (additionalProperties: false at the import entry level) and by `parseImportSpecsFromArray` in `pkg/parser/import_bfs.go`.
2. `.github/aw/syntax-agentic.md` — verify `max-turn-cache-misses` maps to `apiProxy.maxCacheMisses` with default `5` in the schema.
3. `.github/aw/syntax-agentic.md` — verify `engine.permission-mode` is a real Claude engine field with enum `auto`/`acceptEdits`/`plan`/`bypassPermissions` in `main_workflow_schema.json`.
If all three check out, approve the PR.

Generated by ✅ Contribution Check · 138 AIC · ⌖ 14.3 AIC · ⊞ 5.9K ·

@github-actions

Copy link
Copy Markdown
Contributor Author

Ask Copilot to confirm the schema-linked instruction sync and summarize any remaining validation gaps.

Generated by 👨‍🍳 PR Sous Chef · 91.6 AIC · ⌖ 0.985 AIC · ⊞ 17.3K ·

@pelikhan pelikhan merged commit 78b22dc into main Jun 21, 2026
@pelikhan pelikhan deleted the instructions-sync-imports-engine-fields-913ea3d9607aebcd branch June 21, 2026 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation instructions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant