Add an API diff workflow
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 45/100
Piste de recherche
Commencez par lire le workflow existant pour les API breakages et suivez son exécution sur les pull requests. Déterminez comment obtenir le diff de swiftinterface, ou un équivalent pour les packages sans library evolution, et comparez sa présentation sous forme de commentaire de PR à sa présentation dans la sortie d’un GitHub check. Le travail est terminé lorsque le workflow expose le diff d’API et permet de configurer les modules inclus.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- Swift
- Étoiles
- 115
- Forks
- 60
- Merge moyen
- 2 j 13 h
- PR mergées (30 j)
- 4
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de swiftlang/github-workflows
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
swiftlang/github-workflows#261 ·
-
Update from actions/checkout@v4 to v6Peut-être pris Une pull request liée à cette issue est ouverte ou déjà fusionnée. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
swiftlang/github-workflows#258 · 1 commentaire ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 68/100
swiftlang/github-workflows#312 ·
-
Android testing is broken with swiftbuildPeut-être pris Une pull request liée à cette issue est ouverte ou déjà fusionnée. Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 58/100
swiftlang/github-workflows#277 · 1 commentaire ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 52/100
swiftlang/github-workflows#267 ·
Toutes les issues de swiftlang/github-workflows
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
raullenchai/Rapid-MLX#4889 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 75/100
Les mainteneurs répondent en général sous 1 jour
-
iOS-2026
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
mozilla-mobile/firefox-ios#36150 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 83/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
openwatersio/slackwater-ios#736 ·
Les mainteneurs répondent en général sous 1 jour