Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#37 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

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

Línea de trabajo

Comienza localizando el flujo de trabajo de GitHub Actions que actualmente ejecuta las comprobaciones para los pull requests. Reutiliza ese job como base para una ejecución programada cuatro veces al día y, después, verifica que los fallos se notifiquen mediante GitHub Actions. La selección de la carretera y de los momentos queda explícitamente para una posterior revisión.

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

Descripción

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.

Lenguaje dominante
Python
Estrellas
153
Forks
10
Sin PR fusionados en 30 d

Preparar el entorno

Aún no hemos revisado los archivos de configuración de este proyecto. Empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de bundesAPI/autobahn-api

Todos los issues de bundesAPI/autobahn-api

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.