Azure
Add comprehensive GitHub Copilot instructions for development workflow
This PR adds comprehensive GitHub Copilot instructions to help AI coding agents work effectively in the azure-workload-identity codebase. The instructions provide a complete guide for building, testing, and developing the project from a fresh clone.
Key Features
Validated Commands and Timing: All build and test commands have been thoroughly tested and timed to provide accurate timeout recommendations:
-
make generate: ~60s first time (downloads controller-gen and tools) -
make test: ~4 minutes with full coverage validation (78.7%) -
make lint: ~2 minutes first time (downloads golangci-lint) -
make manager,make proxy,make bin/azwi: All validated and timed
Comprehensive Coverage: The instructions cover:
- Prerequisites and setup requirements (Go 1.24.6+, jq, make, docker, kind)
- Complete build workflow from bootstrap to deployment
- Unit testing and linting validation
- Local development with Kind clusters
- Manual validation scenarios for all built binaries
- Repository structure and key file locations
- Development workflow best practices
Safety and Reliability: Following the guidelines for exhaustive validation:
- Every command has been executed and verified to work
- Explicit "NEVER CANCEL" warnings with appropriate timeout values
- Manual validation steps to ensure binaries function correctly
- Clear guidance on when operations are expected to take time
Developer Experience: The instructions are written in imperative tone and provide:
- Firm directive to follow instructions first before additional search
- Step-by-step workflows for common development tasks
- Troubleshooting guidance for build artifacts and dependencies
- Integration with CI/CD requirements
The instructions enable any GitHub Copilot agent to effectively work in this Kubernetes-focused Go project without trial-and-error, reducing development friction and ensuring consistent, reliable builds.
Fixes #1652.
[!WARNING]
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
management.azure.com
- Triggering command:
/tmp/go-build3024814826/b1088/auth.test -test.paniconexit0 -test.gocoverdir=/tmp/go-build3024814826/b1088/gocoverdir -test.timeout=10m0s -test.v=true -test.coverprofile=/tmp/go-build3024814826/b1088/_cover_.out(dns block)- Triggering command:
/tmp/go-build227839077/b1088/auth.test -test.paniconexit0 -test.gocoverdir=/tmp/go-build227839077/b1088/gocoverdir -test.timeout=10m0s -test.v=true -test.coverprofile=/tmp/go-build227839077/b1088/_cover_.out(dns block)If you need me to access, download, or install something from one of these locations, you can either:
- Configure Actions setup steps to set up my environment, which run before the firewall is enabled
- Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.
@aramase 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.
I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.