From d1a257a3a1b402b827247dca10ffbe44985d37a7 Mon Sep 17 00:00:00 2001 From: Alexander Zaslonov Date: Fri, 25 Sep 2026 08:58:08 -0700 Subject: [PATCH] docs: clarify README identity setup uses GitHub Copilot prompt file 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. --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b438e654..c51f9565 100644 --- a/README.md +++ b/README.md @@ -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 (Ctrl+Alt+I), 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. +- **Manual setup:** follow the instructions in the generated `APIOPS-WORKFLOW-IDENTITY-SETUP.md`. Required repository secrets: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`