bundesAPI / bundesAPI/api-doc-template

OpenAPI Check Workflow (Annotations) not working correctly

オープン
#6 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
HTML
スター
6
フォーク
4
PR マージ指標
30日以内にマージされた PR はありません

説明

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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

.github/workflows/openapi_check.yaml から始め、リンクされている stoplightio/spectral-action の issue #646 とその動作を比較します。アノテーションが workflow の実行にどのように付加されるかを確認し、そのうえで警告とエラーが正しい実行に表示されること、また OpenAPI ファイルが存在する場合に両方またはすべてのファイルがチェックされることを検証します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
github-actions, yaml
領域
api, ci-cd
issue の種類
バグ
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。