Skip to content

fix: address PR #183 review feedback on Copilot prompts and docs#196

Draft
Copilot wants to merge 2 commits into
mainfrom
copilot/address-pr-183-feedback
Draft

fix: address PR #183 review feedback on Copilot prompts and docs#196
Copilot wants to merge 2 commits into
mainfrom
copilot/address-pr-183-feedback

Conversation

Copilot AI commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #183 (feat: add JSON schemas and Copilot prompts). Several reviewer comments were deferred; this PR addresses them all.

Docs

  • docs/guides/environment-overrides.md and docs/guides/filtering-resources.md: Added a fallback paragraph pointing users who skipped apiops init to the prompt source files on GitHub, with copy-to instructions.

Prompt formatting

  • Removed hard 80-col line breaks throughout configure-filter-prompt.md and configure-overrides-prompt.md. Content unchanged; editors handle wrapping.

Prompt behavior — configure-overrides-prompt.md

Step 3 — Pipeline token discovery

Old: ask the user to enumerate pipeline variables manually.
New, in order:

  1. Inspect .github/workflows/ / .azdo/pipelines/ to find env:, vars.*, secrets.* references first.
  2. Run gh --version; if available, offer to auto-query gh variable list / gh secret list (names only, no values) with explicit user permission.
  3. Cross-validate any user-provided token names against the discovered set; warn on mismatches.

Step 5 — Finalize

  • Added structural schema validation: top-level keys checked against known resource section names, every list item verified to have name + properties, schema URL fetched when possible.
  • Replaced the ambiguous "show the files" instruction with: ask the user to review each file before checking it in.

Prompt naming

apiops- prefix on all generated prompt filenames (apiops-configure-filter.prompt.md, apiops-configure-overrides.prompt.md, apiops-setup-identity.prompt.md) was already implemented in #183; confirmed correct, no change needed.

…d docs

- Add links to prompt template source files for users who skipped `apiops init`
  in docs/guides/environment-overrides.md and docs/guides/filtering-resources.md
- Remove artificial word wrapping from configure-filter-prompt.md and
  configure-overrides-prompt.md (let editors handle text wrap)
- configure-overrides-prompt.md Step 3: inspect pipeline files first to
  discover existing variables before asking the user
- configure-overrides-prompt.md Step 3: run `gh --version` and offer to
  auto-query `gh variable list`/`gh secret list` (names only) with permission
- configure-overrides-prompt.md Step 3: validate user-provided token names
  against discovered pipeline variables (warn on mismatch)
- configure-overrides-prompt.md Step 5: structural YAML schema validation
  (top-level keys, name+properties shape, obvious misspellings)
- configure-overrides-prompt.md Step 5: replace vague "show" with ask-user-
  to-review-before-checking-in instruction
- Prompt naming (apiops- prefix) already implemented; no change needed

Closes #195
Copilot AI changed the title [WIP] Refine Copilot prompt templates and documentation fix: address PR #183 review feedback on Copilot prompts and docs Jun 29, 2026
Copilot AI requested a review from EMaher June 29, 2026 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Address PR #183 review feedback: Copilot prompt refinements and docs

2 participants