{CI} Linter check faulty_help_example_parameters_rule error
@wangzelin007 is already working on this.
Since Apr 28, 2022.
Assessment
This issue has not been assessed yet.
Description
Linter check raise the following error in PR:
https://dev.azure.com/azure-sdk/public/_build/results?buildId=1532217&view=logs&j=168ccbe3-da49-5c0b-6478-08f7016e4bf5&t=10a595be-4223-5cc7-9a73-012871b6eaee&s=96ac2280-8cb4-5df5-99de-dd2da759617d
After debugging, it is caused by:
https://github.com/Azure/azure-cli-dev-tools/blob/c94bff479f633845ccce1279eebac60426e985ab/azdev/operations/linter/rules/help_rules.py#L124
Linter rule faulty_help_example_parameters_rule will get example_text from _help.py file.
One of the generated example_text
az aks connection create keyvault -g ClusterRG -n MyCluster --tg KeyvaultRG --vault MyVault --service-principal client-id=XX secret=XX missing optional parameter object-id=XX
The workaround is adding object-id=XX to _help.py file
The following three problems need to be solved :
- The generation logic of example_text
- How to optimize the error message, there is no connection between the current error log and the actual problem.
- An exception in one of the linter checks will cause the remaining linter checks to abort and exit
- Dominant language
- Python
- Stars
- 91
- Forks
- 134
- Avg merge
- 2h 51m
- Merged PRs (30d)
- 1
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Azure/azure-cli-dev-tools
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
Azure/azure-cli-dev-tools#310 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
Azure/azure-cli-dev-tools#529 ·
-
Azure/azure-cli-dev-tools#525 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
Azure/azure-cli-dev-tools#520 ·
-
Azure/azure-cli-dev-tools#519 · 1 comment · 1 reaction · 1 assignee ·
All issues in Azure/azure-cli-dev-tools
Similar issues
-
essnmx good first issue
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
[Feature] 奇物选择添加优先级 Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
syfoud/Simulated_Scepter#174 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Giskard-AI/giskard-oss#2840 · 1 comment ·
-
A claim comment carrying the issue number is silently declined while the workflow reports success Openarea: repo bug perceived difficulty: 2
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
yeti-platform/yeti#1380 ·