Azure / Azure/azure-powershell

Improve CreateMappings.ps1

Open
#10,669 0 comments 0 reactions 0 assignees View on GitHub
Azure PS Team Engineering feature-request
Dominant language
C#
Stars
4.8k
Forks
4.3k
Avg merge
3d 14h
Merged PRs (30d)
54

Description

## Description
Inspired by the issue https://github.com/Azure/azure-powershell/issues/10613

It is found that CreateMappings.ps1 generates help file to alias mapping using CreateMappings_rules.json.
It searches for the keywords of different rules in help file's path and file, if any match, choose a best one.

When more than one rules are hit, the current solution is ordering rule according to priority in CreateMappings_rules.json and selecting the first matched rule in CreateMappings.ps1.

The problem is if it is impossible to prioritize two rules how to handle the case.
Here is a example case.
Get-AzComputedNetworkxxxxx
Rule1: Compute
Rule2 :Network
Which rule should be applied to the case?
## Cost

Contributor guide

Open the contributing guide

Research direction

Review CreateMappings.ps1 and CreateMappings_rules.json to understand how help-file paths and contents are matched and how priority is applied. Trace the example with both Compute and Network matches, then determine and document the intended handling for rules that cannot be prioritized; the mapping process should produce a defined, consistent result for such cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.