Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Run GHA against `main` periodically to catch API changes and/or previously unknown features

オープン
#37 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

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

調査の方向性

まず、現在 pull requests のチェックを実行している GitHub Actions のワークフローを見つけます。その job を基に、1 日 4 回のスケジュール実行を設定し、続いて失敗が GitHub Actions によって報告されることを確認します。道路と時点の選定は、明示的に後で改良するものとします。

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

説明

Checks for #33 failed, but apparently for reasons related to the API itself rather than the changes in the PR (see https://github.com/bundesAPI/autobahn-api/pull/33#issuecomment-1575137487 for details). In this case it is because of the API not supplying the content type (any more?), as well as an enum value we were previously not aware of.

Our main challenge is that we’re checking against a reverse-engineered API, which may change its behavior or reveal previously unknown features any time, and against data which changes frequently. For this reason it might be a good idea to run GHA on main periodically. If that fails all of a sudden, it’s a sign we missed something, or the API changed.

I have a similar use cases for milestones and road numbers used in a traffic service for Poland. There the main point is to find road number/milestone combinations which are not in OpenStreetMap yet, which won’t become apparent until they’re mentioned in a traffic message. Ideally we would want to check each and every traffic message, but that is not feasible. Instead, I chose to work on a representative set of traffic messages.

I poll the API at 1:30, 9:00, 13:30 and 18:00 each day, which should get me roadworks during the night (1:30), particular situations during peak hours (9:00 and 18:00) as well as daytime situations (13:30). The main difference is that the API I run this against has a single endpoint for all motorways, expressways and national roads in Poland, whereas Autobahn-API has one endpoint per road. So we might need a representative set of not only time points, but also of roads – preferably roads which are prone to getting traffic reports – but I would rather start with running the same job we run on a PR four times a day, and refining it later on.

主要言語
Python
スター
153
フォーク
10
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

bundesAPI/autobahn-api のほかの issue

bundesAPI/autobahn-api の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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