Skip to content

New "Azd best practices" skill - #2549

Open
massimobonanni wants to merge 3 commits into
github:mainfrom
massimobonanni:AZD_best_practices_skill
Open

New "Azd best practices" skill#2549
massimobonanni wants to merge 3 commits into
github:mainfrom
massimobonanni:AZD_best_practices_skill

Conversation

@massimobonanni

Copy link
Copy Markdown

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have read and followed the Guidance for submissions involving paid services.
  • My contribution adds a new instruction, prompt, agent, skill, workflow, or canvas extension file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, agent, skill, workflow, or canvas extension with GitHub Copilot.
  • I have run npm start and verified that README.md is up to date.
  • I am targeting the main branch 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 new azure-developer-cli skill 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:


Type of Contribution

  • New instruction file.
  • New prompt file.
  • New agent file.
  • New plugin.
  • New skill file.
  • New agentic workflow.
  • New canvas extension.
  • Update to existing instruction, prompt, agent, plugin, skill, workflow, or canvas extension.
  • Other (please specify):

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.

Copilot AI balanced review requested due to automatic review settings August 5, 2026 13:15
@github-actions github-actions Bot added new-submission PR adds at least one new contribution skills PR touches skills labels Aug 5, 2026
@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

🔒 PR Risk Scan Results

Scanned 6 changed file(s).

Severity Count
🔴 High 0
🟠 Medium 0
ℹ️ Info 0

✅ No matching risk patterns were detected in changed files.

This is an automated soft-gate report. Findings indicate review targets and do not block merge by themselves.

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

🔍 Vally Lint Results

✅ All checks passed

Scope Checked
Skills 1
Agents 0
Total 1
Severity Count
❌ Errors 0
⚠️ Warnings 0
ℹ️ Advisories 0

Summary

Level Finding
ℹ️ ✅ azure-developer-cli (2/2 checks passed)
ℹ️ ✓ [spec-compliance] All 1 skill(s) are spec-compliant.
ℹ️ ✓ spec-compliance: All spec checks passed.
ℹ️ ✓ [valid-refs] All file references across 1 skill(s) are valid.
ℹ️ ✓ valid-refs: All file references resolve to existing files within the skill directory.
ℹ️ 1 skill(s) linted, 1 passed
Full linter output
### Linting skills/azure-developer-cli
✅ azure-developer-cli (2/2 checks passed)
    ✓ [spec-compliance] All 1 skill(s) are spec-compliant.
        ✓ spec-compliance: All spec checks passed.
    ✓ [valid-refs] All file references across 1 skill(s) are valid.
        ✓ valid-refs: All file references resolve to existing files within the skill directory.

1 skill(s) linted, 1 passed

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread skills/azure-developer-cli/SKILL.md Outdated
@@ -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>
Copilot AI review requested due to automatic review settings August 5, 2026 14:34

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.yaml is not referenced anywhere in the skill instructions, so an agent loading SKILL.md has 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 config supports 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new-submission PR adds at least one new contribution skills PR touches skills

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants