fix: address PR #183 review feedback on Copilot prompts and docs#196
Merged
Conversation
9 tasks
…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
EMaher
requested changes
Jul 1, 2026
Contributor
|
@copilot - handle comments on this PR |
Contributor
Author
EMaher
approved these changes
Jul 1, 2026
petehauge
approved these changes
Jul 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdanddocs/guides/filtering-resources.md: Added a fallback paragraph pointing users who skippedapiops initto the prompt source files on GitHub, with copy-to instructions.Prompt formatting
configure-filter-prompt.mdandconfigure-overrides-prompt.md. Content unchanged; editors handle wrapping.Prompt behavior —
configure-overrides-prompt.mdStep 3 — Pipeline token discovery
Old: ask the user to enumerate pipeline variables manually.
New, in order:
.github/workflows//.azdo/pipelines/to findenv:,vars.*,secrets.*references first.gh --version; if available, offer to auto-querygh variable list/gh secret list(names only, no values) with explicit user permission.Step 5 — Finalize
name+properties, schema URL fetched when possible.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.