Skip to content

Fix Template Doctor compliance issues - LICENSE file, GitHub workflow naming, README structure, and Bicep metadata #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link

@Copilot Copilot AI commented Jul 30, 2025

This PR addresses all 20 Template Doctor compliance issues to improve the repository's compliance score from 29% to 100%.

Changes Made

1. LICENSE File Issue

Created a LICENSE file (in addition to the existing LICENSE.md) to satisfy the Template Doctor requirement for an exact filename match.

2. GitHub Workflow Naming

Renamed .github/workflows/azure-dev.yaml to .github/workflows/azure-dev.yml to match the expected filename format.

3. README.md Structure

  • Changed "Architecture diagram" to "Architecture" to properly format as an h2 heading
  • Added a new "Prerequisites" h2 section that lists all required tools and dependencies:
    • Azure Developer CLI (azd)
    • Node.js 18+
    • Python 3.10+
    • PostgreSQL 14+ with pgvector extension
    • Docker Desktop
    • Git

4. Bicep Template Metadata

Added @metadata blocks with requiredResources properties to all 16 Bicep infrastructure files. Each file now includes:

  • A description of what the template creates
  • An array of Azure resource types (requiredResources) that the template provisions

For example:

@metadata({
  description: 'Creates a Log Analytics workspace.'
  requiredResources: [
    'Microsoft.OperationalInsights/workspaces'
  ]
})

The following files were updated:

  • infra/main.bicep - Main deployment template
  • infra/backend-dashboard.bicep - Application Insights dashboard
  • infra/web.bicep - Web container app
  • All files in infra/core/ directories (AI, database, host, monitor, security modules)

Validation

  • All Bicep files compile successfully with az bicep build
  • Only linting warnings remain (safe access operators, unused parameters) - no syntax errors
  • README.md now includes both required h2 headings
  • LICENSE file exists in the expected location
  • GitHub workflow uses the expected .yml extension

This resolves all Template Doctor compliance issues and should achieve 100% compliance.

Fixes #1.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • aka.ms
    • Triggering command: bicep build infra/core/monitor/loganalytics.bicep --stdout (dns block)
    • Triggering command: bicep build infra/core/monitor/applicationinsights.bicep --stdout (dns block)
    • Triggering command: bicep build infra/core/ai/cognitiveservices.bicep --stdout (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI and others added 2 commits July 30, 2025 07:34
Co-authored-by: anfibiacreativa <4014025+anfibiacreativa@users.noreply.github.com>
…tor compliance

Co-authored-by: anfibiacreativa <4014025+anfibiacreativa@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Template Doctor Analysis: 29% compliant [2025-07-30] Fix Template Doctor compliance issues - LICENSE file, GitHub workflow naming, README structure, and Bicep metadata Jul 30, 2025
@Copilot Copilot AI requested a review from anfibiacreativa July 30, 2025 07:56
Copilot finished work on behalf of anfibiacreativa July 30, 2025 07:56
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.

Template Doctor Analysis: 29% compliant [2025-07-30]
2 participants