Azure / Azure/azure-powershell

CI Validation (static analysis)

Open
#16,429 1 comment 0 reactions 0 assignees View on GitHub
Engineering
Dominant language
C#
Stars
4.8k
Forks
4.3k
Avg merge
3d 14h
Merged PRs (30d)
54

Description

The proposal of this issue is to add a static analysis CI to PRs of generation branch to check problems which:

- can be hard to find during human review
- will cause the CI to fail, but the error message cannot be understood

## Check for syntax of comment-based documentation of customized functions

Problem: In a customized powershell function, if the number of empty lines between comment-based help document and function definition >= 2, the generated help document will have empty synopsis, description and parameter descriptions.

Root cause: this is expected behavior of comment-based document - when the empty lines >= 2, the scope of the comment is diffeerent.

## Check if commit id is fixed

Problem: when commit id is not fixed, it's like a timed bomb, as soon as swagger changes, it's very likely to explode. We should check this in CI.,

Contributor guide

Open the contributing guide

Research direction

No files, tests, or CI entry points are named. Start by locating the generation branch's PR CI configuration and existing validation checks, then determine how customized PowerShell functions and dependency commit IDs are represented. Done means CI reports the two described problems with understandable failures.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.