Commit 9435d71
Add AI resources for GitHub issue handling and debugging support, Fixes AB#3377270 (#2411)
Adds AI-agent resources for triaging GitHub issues **and** providing
general debugging support to users across all interaction channels: a
common issues reference guide, customer communication guidelines, and an
automated workflow for initial issue triage.
## Capabilities
This PR enables AI agents to:
1. **Respond to GitHub issues** — Automatic classification, labeling,
and context-aware initial responses
2. **Provide debugging support** — Help users troubleshoot stack traces,
error codes, and code patterns in web chat and agent sessions
3. **Identify bad calling patterns** — Detect deprecated APIs and
anti-patterns in customer code snippets
4. **Dynamically check latest MSAL version** — Query GitHub releases API
to reference current version without manual updates, **especially when
generating app code or build.gradle files**
## New Resources
- **`.github/issue-responses/common-issues-guide.md`** — Comprehensive
troubleshooting reference compiled from 250+ existing GitHub issues
(open and closed), covering:
- Error patterns and stack trace signatures (AADSTS codes, R8/ProGuard
crashes, broker issues)
- References official [Microsoft Identity Platform Error
Codes](https://learn.microsoft.com/en-us/entra/identity-platform/reference-error-codes)
documentation as authoritative source for error meanings
- Configuration issues (redirect URI encoding, manifest setup,
auth_config.json)
- Runtime issues (token acquisition, silent refresh, account mode)
- Build issues (dependency resolution, ProGuard rules, Android 15
compatibility)
- B2C-specific patterns and solutions
- **Recommendation to upgrade to latest MSAL version** for better
compatibility
- **`.github/issue-responses/customer-communication-guidelines.md`** —
Response templates, triage criteria, escalation procedures, and
communication best practices for **all interaction channels** (GitHub
issues, web chat, agent sessions). **Includes all three broker hosting
applications: Microsoft Authenticator, Company Portal, and Link to
Windows.**
- **`.github/workflows/copilot-issue-response.yml`** — Automated
workflow that classifies issues, applies labels, generates initial
responses, and detects common error patterns.
## Updated
- **`.github/copilot-instructions.md`** — Added prominent "AI AGENTS:
THIS IS YOUR PRIMARY SOURCE OF TRUTH" callout, reference to official
Microsoft identity error codes documentation, and **instructions to
programmatically check GitHub releases API for current MSAL version when
generating app code or providing setup guidance**
- **`Ai.md`** — Added prominent callout directing AI agents to
`.github/copilot-instructions.md` and **instructions to query releases
API for latest version**
- **`README.md`** — Added "AI AGENTS: PRIMARY INSTRUCTIONS" callout with
**note about checking GitHub releases API**
- **MSAL version references** — Updated to reference 8.1.1 (latest as of
December 2024) with guidance to check releases API for current version
## Dynamic Version Checking
AI agents are now instructed to programmatically check the GitHub
releases API to ensure they always reference the current latest MSAL
version:
- **Endpoint**:
`https://api.github.com/repos/AzureAD/microsoft-authentication-library-for-android/releases/latest`
- **Parse**: `tag_name` field (e.g., "v8.1.1")
- **When generating code**: Always query the API instead of using
hardcoded values from sample files
- **Recommend**: Use `8.+` in build.gradle for automatic updates within
the 8.x series
This eliminates the need for manual documentation updates when new MSAL
versions are released and ensures AI-generated code always uses the
latest version.
<!-- START COPILOT CODING AGENT TIPS -->
---
✨ Let Copilot coding agent [set things up for
you](https://github.com/AzureAD/microsoft-authentication-library-for-android/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot)
— coding agent works faster and does higher quality work when set up for
your repo.
[AB#3377270](https://identitydivision.visualstudio.com/fac9d424-53d2-45c0-91b5-ef6ba7a6bf26/_workitems/edit/3377270)
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: fadidurah <88730756+fadidurah@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>1 parent b2b91b3 commit 9435d71
File tree
7 files changed
+2354
-6
lines changed- .github
- issue-responses
- workflows
7 files changed
+2354
-6
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
3 | 20 | | |
4 | 21 | | |
5 | 22 | | |
| |||
31 | 48 | | |
32 | 49 | | |
33 | 50 | | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
34 | 56 | | |
35 | 57 | | |
36 | 58 | | |
| |||
74 | 96 | | |
75 | 97 | | |
76 | 98 | | |
77 | | - | |
| 99 | + | |
78 | 100 | | |
79 | 101 | | |
80 | 102 | | |
| |||
144 | 166 | | |
145 | 167 | | |
146 | 168 | | |
147 | | - | |
| 169 | + | |
148 | 170 | | |
149 | 171 | | |
150 | 172 | | |
151 | 173 | | |
152 | 174 | | |
153 | 175 | | |
154 | 176 | | |
155 | | - | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
0 commit comments