Skip to content

Commit b33c1ea

Browse files
authored
Merge pull request #299 from azaslonov/docs/readme-copilot-identity-setup
docs: clarify README identity setup uses GitHub Copilot prompt file
2 parents ca5b16e + d1a257a commit b33c1ea

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@ npm install -g @azure-tools/apiops-cli
2222

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

25-
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.
25+
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:
26+
27+
- **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.
28+
- **Manual setup:** follow the instructions in the generated `APIOPS-WORKFLOW-IDENTITY-SETUP.md`.
2629

2730
Required repository secrets: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`
2831

0 commit comments

Comments
 (0)