Add an API diff workflow
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 45/100
Línea de trabajo
Empieza leyendo el workflow existente para las API breakages y sigue cómo se ejecuta en los pull requests. Determina cómo obtener el diff de swiftinterface, o un equivalente para paquetes sin library evolution, y compara presentarlo como un comentario del PR frente a mostrarlo como salida de un GitHub check. Se considera terminado cuando el workflow muestra el diff de la API y permite configurar qué módulos se incluyen.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
In addition to the existing API breakage workflow, it'd be helpful to see the diff of the swiftinterface file (or equivalent for packages that can't build with library evolution enabled) that the PR is making.
When a package has a large diff where most of the code is implementation, it can be difficult to spot the exact API changes it's making.
There are a few ways this could be surfaced to the user:
- Option A: A comment posted by the workflow back on the PR
- Option B: The workflow just printing the diff and the user needing to click on the GitHub check link and reviewing it manually
Either would be fine to start.
Presumably, this would come with some configurability, mainly the list of modules to diff - there might be internal modules that the maintainer might not care about seeing the diff of, and might even cause noise.
- Lenguaje dominante
- Swift
- Estrellas
- 115
- Forks
- 57
- Merge medio
- 1 d 8 h
- PR fusionados (30 d)
- 3
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de swiftlang/github-workflows
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
swiftlang/github-workflows#305 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
swiftlang/github-workflows#261 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
swiftlang/github-workflows#258 · 1 comentario ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
swiftlang/github-workflows#312 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 58/100
swiftlang/github-workflows#277 · 1 comentario ·
Todos los issues de swiftlang/github-workflows
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
uttrflow/uttrflow-swift#1439 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
googleapis/google-cloud-swift#1151 ·
-
`--app` focus through the daemon can pick an off-screen window and refuse with `axElementNotFound` Abiertoclawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:other issue-rating: 🦞 diamond lobster no-stale P1
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
code health
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
apple/coreai-models#288 ·