bundesAPI / bundesAPI/api-doc-template
OpenAPI Check Workflow (Annotations) not working correctly
- Vorherrschende Sprache
- HTML
- Sterne
- 6
- Forks
- 4
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginnen Sie mit .github/workflows/openapi_check.yaml und vergleichen Sie dessen Verhalten mit dem verknüpften stoplightio/spectral-action Issue #646. Bestätigen Sie, wie Anmerkungen an Workflow-Ausführungen angehängt werden, und überprüfen Sie anschließend, dass Warnungen und Fehler in der korrekten Ausführung erscheinen und dass beide oder alle OpenAPI-Dateien geprüft werden, sofern sie vorhanden sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- github-actions, yaml
- Bereich
- api, ci-cd
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100