Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

{CI} Linter check faulty_help_example_parameters_rule error

Đang mở
#331 0 bình luận 0 reaction 1 người được giao Xem trên GitHub

@wangzelin007 đang làm issue này rồi.

Từ ngày 28/4/2022.

Đánh giá

Issue này chưa được đánh giá.

Mô tả

bug CI

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
image

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 :

  1. The generation logic of example_text
  2. How to optimize the error message, there is no connection between the current error log and the actual problem.
  3. An exception in one of the linter checks will cause the remaining linter checks to abort and exit
Ngôn ngữ chính
Python
Star
91
Fork
134
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Azure/azure-cli-dev-tools

Tất cả issue của Azure/azure-cli-dev-tools

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.