bundesAPI / bundesAPI/api-doc-template

OpenAPI Check Workflow (Annotations) not working correctly

Abierto
#6 1 comentario 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
HTML
Estrellas
6
Forks
4
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

The [OpenAPI check](https://github.com/bundesAPI/api-doc-template/blob/main/.github/workflows/openapi_check.yaml) is currently not working correctly.

The annotations which show warnings or errors for the openapi file are sometimes not added at all or sometimes just added to another workflow run.

See: https://github.com/stoplightio/spectral-action/issues/646

Maybe we have to fix the action by ourself since it looks like stoplight does not work on the github action anymore.

We should also think about testing both (or all) openapi files if they exist.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Comienza con .github/workflows/openapi_check.yaml y compara su comportamiento con el issue #646 vinculado de stoplightio/spectral-action. Confirma cómo se adjuntan las anotaciones a las ejecuciones del workflow y, a continuación, verifica que las advertencias y los errores aparezcan en la ejecución correcta y que se comprueben ambos o todos los archivos OpenAPI cuando estén presentes.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
github-actions, yaml
Área
api, ci-cd
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.