Skip to content

chore: Bicep Parameter validation email format change#969

Merged
Roopan-Microsoft merged 11 commits into
microsoft:dev-v4from
NirajC-Microsoft:dev-v4
May 8, 2026
Merged

chore: Bicep Parameter validation email format change#969
Roopan-Microsoft merged 11 commits into
microsoft:dev-v4from
NirajC-Microsoft:dev-v4

Conversation

@NirajC-Microsoft

Copy link
Copy Markdown
Contributor

Purpose

This pull request enhances the Bicep parameter validation workflow by adding support for a structured HTML email report and improving notification handling. The main improvements include generating a detailed HTML report for validation results, updating the workflow to use this HTML output for email notifications, and refactoring the notification logic for clarity and maintainability.

HTML Email Reporting:

  • Added a new generate_html_report function in validate_bicep_params.py to create a structured, Outlook-compatible HTML report summarizing validation results, including error and warning counts, per-file details, and workflow run links.
  • Introduced new CLI arguments (--html-output, --accelerator-name, --run-url) to allow the script to generate and save the HTML report with contextual information.

Workflow and Notification Improvements:

  • Updated the GitHub Actions workflow (.github/workflows/validate-bicep-params.yml) to:
    • Generate the HTML report during validation and upload it as an artifact. [1] [2]
    • Use the HTML report as the body for both failure and success notification emails, replacing the previous plain text approach. [1] [2]

Code Integration:

  • Integrated HTML report generation into the main validation script, ensuring the report is written alongside the JSON output when requested.

These changes provide more readable, actionable, and visually appealing validation notifications for the team.

Does this introduce a breaking change?

  • Yes
  • No

How to Test

  • Get the code
git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
npm install
  • Test the code

What to Check

Verify that the following are valid

  • ...

Other Information

This comment was marked as outdated.

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 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread infra/scripts/validate_bicep_params.py Outdated
@Roopan-Microsoft Roopan-Microsoft merged commit 61ff047 into microsoft:dev-v4 May 8, 2026
3 checks passed
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 4.2.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants