進捗バッジとレポート

進捗レポートを公開する

READMEからdecomphub.progress.jsonにリンクします。各指標には固定ID、明確な対象範囲、測定値を指定します。進捗不明の場合はnullにしてください。コードの一致率、シェーダーのデコード、互換性は別々に扱います。

構造の例です。リポジトリと対象範囲を置き換えてください。進捗率は仮定していません。

{
  "format": "decomphub.progress/v1",
  "repository": "https://github.com/boykopovar/anyps5",
  "tracks": [
    {
      "id": "matching-code",
      "label": "Matching code",
      "scope": "Target version and measurement boundary",
      "measurement": null
    }
  ]
}

このレポートへのリンクをREADMEに追加

[Progress data](decomphub.progress.json)

各測定値には出典と対象範囲を保持します。日付は任意です。省略時は出典を確認した日時を表示します。異なる指標を平均することはありません。

マージ後に更新する

変更がデフォルトブランチに入った後、CIでレポートを生成して公開し、この通知を追加します。既存の処理がプロバイダーの制限に従い、各プロジェクトにつき最大1時間に1回、出典を読み取ります。通知から進捗率を受け取ることはありません。定期取得も継続します。

- name: Notify DecompHub
  env:
    PROJECT_REPOSITORY: https://github.com/${{ github.repository }}
    PROJECT_REVISION: ${{ github.sha }}
  run: |
    jq -n --arg repository "$PROJECT_REPOSITORY" --arg revision "$PROJECT_REVISION" \
      '{repository: $repository, revision: $revision}' |
      curl --fail --silent --show-error --max-time 20 \
        -H "Content-Type: application/json" --data-binary @- \
        https://app.decomphub.com/api/progress/refresh

進捗バッジとレポート

このMarkdownをREADMEに貼り付けてください

進捗レポートを公開する

マージ後に更新する