Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

{CI} Linter check faulty_help_example_parameters_rule error

Abierto
#331 0 comentarios 0 reacciones 1 asignado Ver en GitHub

@wangzelin007 ya está trabajando en esto.

Desde el 28/4/2022.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

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
Lenguaje dominante
Python
Estrellas
91
Forks
134
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Azure/azure-cli-dev-tools

Todos los issues de Azure/azure-cli-dev-tools

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.