Skip to content

docs: clarify README identity setup uses GitHub Copilot prompt file - #299

Merged
Alexander Zaslonov (azaslonov) merged 1 commit into
Azure:mainfrom
azaslonov:docs/readme-copilot-identity-setup
Sep 25, 2026
Merged

Alexander Zaslonov (azaslonov) merged 1 commit into
Azure:mainfrom
azaslonov:docs/readme-copilot-identity-setup

Conversation

@azaslonov

Copy link
Copy Markdown
Member

Summary

Clarifies in the README that the identity setup prompt file generated by apiops init is meant to be used with GitHub Copilot Chat in VS Code, for readers not familiar with Copilot prompt files.

Changes

  • README.md (Authentication > Generated GitHub Actions workflows):
    • Explains the prompt file is for GitHub Copilot and gives concrete steps: open Copilot Chat (Ctrl+Alt+I), select Agent mode, run /apiops-setup-workflow-identity.
    • Links to the prompt files guide and GitHub Copilot in VS Code docs.
    • Fixes the file name (identity-setup.prompt.md -> .github/prompts/apiops-setup-workflow-identity.prompt.md, as generated by apiops init).
    • Mentions the manual alternative, APIOPS-WORKFLOW-IDENTITY-SETUP.md.

Related Issue(s)

None (addresses review feedback).

Explain that the generated identity setup prompt file is used from GitHub
Copilot Chat in VS Code (/apiops-setup-workflow-identity), fix the prompt
file name, and mention the manual APIOPS-WORKFLOW-IDENTITY-SETUP.md option.
Copilot AI balanced review requested due to automatic review settings September 25, 2026 16:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

The linked guide conflicts with the generated filename, and the keyboard shortcut omits macOS.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 2 Low severity

Open (2)
What changed in this PR

Clarifies how to configure generated GitHub Actions OIDC identity setup using GitHub Copilot or manual instructions.

Changes:

  • Documents the generated Copilot prompt path and invocation.
  • Adds manual setup guidance and relevant links.
File Description
README.md Expands GitHub Actions identity setup instructions.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md
Comment thread README.md
@azaslonov
Alexander Zaslonov (azaslonov) merged commit b33c1ea into Azure:main Sep 25, 2026
6 checks passed
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.

3 participants