New "Azd best practices" skill - #2549
Open
massimobonanni wants to merge 3 commits into
Open
Conversation
Contributor
🔒 PR Risk Scan ResultsScanned 6 changed file(s).
✅ No matching risk patterns were detected in changed files.
|
Contributor
🔍 Vally Lint Results✅ All checks passed
Summary
Full linter output |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an Azure Developer CLI skill covering project structure, infrastructure, environments, security, CI/CD, and operations.
Changes:
- Adds AZD best-practice instructions and references.
- Includes an example
azure.yaml. - Registers the skill in generated documentation.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
skills/azure-developer-cli/SKILL.md |
Defines the skill workflow and guardrails. |
references/security-cicd-operations.md |
Documents security, hooks, pipelines, and operations. |
references/project-structure.md |
Describes recommended AZD project layouts. |
references/official-docs.md |
Lists official documentation sources. |
references/iac-and-environments.md |
Covers Bicep, Terraform, and environments. |
examples/azure.yaml |
Provides an example AZD manifest. |
docs/README.skills.md |
Registers the new skill. |
| @@ -0,0 +1,134 @@ | |||
| --- | |||
| name: azure-developer-cli | |||
| description: Design, create, review, migrate, or troubleshoot Azure Developer CLI (azd) projects using current Microsoft guidance. Use for azd, azure.yaml, AZD templates, Bicep or Terraform under infra, AZD environments and secrets, hooks, deployment workflows, and azd-managed CI/CD. | |||
| - Repository layout or `azure.yaml`: [references/project-structure.md](references/project-structure.md) | ||
| - Bicep, Terraform, parameters, outputs, or environments: [references/iac-and-environments.md](references/iac-and-environments.md) | ||
| - Secrets, hooks, CI/CD, deployment, or troubleshooting: [references/security-cicd-operations.md](references/security-cicd-operations.md) | ||
| - Product details that may have changed: [references/official-docs.md](references/official-docs.md) |
| - Review generated workflow and permission changes before production use. | ||
| - Rerun it when `pipeline.variables` or `pipeline.secrets` changes. | ||
|
|
||
| For GitHub Actions, AZD configures OIDC/federated credentials by default for supported scenarios. Current documentation says the AZD Terraform pipeline flow does not support OIDC, so evaluate the authentication tradeoff explicitly rather than silently falling back to a long-lived credential. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.
Suppressed comments (2)
skills/azure-developer-cli/SKILL.md:23
- The bundled
examples/azure.yamlis not referenced anywhere in the skill instructions, so an agent loadingSKILL.mdhas no path to discover or use this example. Add it to this resource list, as other skills do for bundled examples (for example,skills/appinsights-instrumentation/SKILL.md:39).
5. Read the relevant reference:
- Repository layout or `azure.yaml`: [references/project-structure.md](references/project-structure.md)
- Bicep, Terraform, parameters, outputs, or environments: [references/iac-and-environments.md](references/iac-and-environments.md)
- Secrets, hooks, CI/CD, deployment, or troubleshooting: [references/security-cicd-operations.md](references/security-cicd-operations.md)
- Product details that may have changed: [references/official-docs.md](references/official-docs.md)
skills/azure-developer-cli/references/security-cicd-operations.md:134
- This generalizes an outdated authentication limitation to every Terraform pipeline flow. Current
azd pipeline configsupports federated/OIDC authentication for Terraform on GitHub Actions; the documented OIDC limitation applies to Azure Pipelines. As written, the skill may steer GitHub users toward unnecessary long-lived credentials.
For GitHub Actions, AZD configures OIDC/federated credentials by default for supported scenarios. Current documentation says the AZD Terraform pipeline flow does not support OIDC, so evaluate the authentication tradeoff explicitly rather than silently falling back to a long-lived credential.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.mainbranch for this pull request.Description
This pull request adds a new "Azure Developer CLI" skill to the repository, including comprehensive documentation, best practices, reference materials, and an example configuration. The changes provide clear guidance for designing, creating, and managing Azure Developer CLI (
azd) projects, as well as references to official Microsoft documentation and practical examples.New Azure Developer CLI skill and documentation:
docs/README.skills.md: Registered the newazure-developer-cliskill with a summary of its capabilities and relevant reference files.skills/azure-developer-cli/SKILL.md: Added a detailed best practices guide for using Azure Developer CLI, covering repository discovery, safety guardrails, defaults, workflows, validation steps, and reporting.Reference materials and examples:
skills/azure-developer-cli/references/iac-and-environments.md: Introduced a reference on infrastructure as code (Bicep and Terraform) and environment management strategies forazdprojects.skills/azure-developer-cli/references/official-docs.md: Added a curated list of official Microsoft documentation links for Azure Developer CLI concepts, infrastructure, environments, and advanced features.skills/azure-developer-cli/examples/azure.yaml: Provided an exampleazure.yamlmanifest demonstrating recommended project structure, service definitions, hooks, and best practices.Type of Contribution
Additional Notes
Nothing
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.