Skip to content

fix: enhance Azure template validation workflow, improve documentation, and update infrastructure configuration#815

Open
Shreyas-Microsoft wants to merge 8 commits intodevfrom
psl-github-issue-azdup
Open

fix: enhance Azure template validation workflow, improve documentation, and update infrastructure configuration#815
Shreyas-Microsoft wants to merge 8 commits intodevfrom
psl-github-issue-azdup

Conversation

@Shreyas-Microsoft
Copy link

Purpose

This pull request introduces several improvements to the Azure template validation workflow and enhances the project documentation for better usability and clarity. The most significant changes are the addition of a new GitHub Actions workflow for Azure template validation, updates to the existing validation workflow, and expanded sections in the README.md to guide users through setup, features, and resource management.

CI/CD and Workflow Enhancements:

  • Added a new workflow file .github/workflows/azure-dev.yml for Azure template validation, which includes steps for checking out code, running the microsoft/template-validation-action, and printing validation results. The workflow is triggered manually (workflow_dispatch) and uses specific permissions and environment variables for secure and flexible execution.
  • Updated the existing .github/workflows/azure-dev-validation.yml to:
    • Set the job environment to production
    • Add new inputs and environment variables to the template validation step, including validateAzd, useDevContainer, and Azure-specific variables for improved validation control and environment flexibility.

Documentation Improvements:

  • Expanded the README.md with new sections:
    • Added a Features section to highlight solution capabilities.
    • Introduced a Getting Started section for onboarding guidance.
    • Added a Guidance section with prerequisites and cost considerations for deployment.
    • Moved and reformatted the cost-saving warning and introduced a Resources table summarizing required Azure services and their costs. [1] [2]

Infrastructure as Code:

  • Updated infra/main.bicep to assign a system-managed identity to the webSiteFrontend module, improving security and enabling resource access without explicit credentials.

Does this introduce a breaking change?

  • Yes
  • No

Golden Path Validation

  • I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

  • I have validated the deployment process successfully and all services are running as expected with this change.

What to Check

Verify that the following are valid

  • ...

Other Information

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants