Skip to content

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

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
Alexander Zaslonov (azaslonov) merged 1 commit into from
Sep 25, 2026
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ npm install -g @azure-tools/apiops-cli

### Generated GitHub Actions workflows (`apiops init`)

Workflows scaffolded by `apiops init` authenticate via **OIDC (workload identity federation)** — no client secret is stored or needed. Run `apiops init` and use the generated `identity-setup.prompt.md` to create an Azure AD application with federated credentials for your GitHub repository.
Workflows scaffolded by `apiops init` authenticate via **OIDC (workload identity federation)** — no client secret is stored or needed. You do need an Azure AD (Microsoft Entra ID) application with federated credentials for your GitHub repository. `apiops init` generates two ways to set it up:

- **Guided setup with GitHub Copilot:** `apiops init` creates `.github/prompts/apiops-setup-workflow-identity.prompt.md`, a [prompt file](docs/guides/prompt-files.md) for [GitHub Copilot in VS Code](https://code.visualstudio.com/docs/copilot/overview). Open the repository in VS Code, open Copilot Chat (<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>I</kbd>), select **Agent** mode, type `/apiops-setup-workflow-identity`, and press Enter. Copilot then walks you through creating the app registration, federated credentials, and repository secrets step by step.
Comment thread
azaslonov marked this conversation as resolved.
Comment thread
azaslonov marked this conversation as resolved.
- **Manual setup:** follow the instructions in the generated `APIOPS-WORKFLOW-IDENTITY-SETUP.md`.

Required repository secrets: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`

Expand Down
Loading