github / github/dependency-submission-toolkit
Add a field for dependency resolution errors
- Langage dominant
- TypeScript
- Étoiles
- 62
- Forks
- 18
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
First of all, I'm sorry if this is not the right place to file this as it's more about the JSON schema for the submissions API, but I could not find a more fitting project to file this for.
Coming from [here](https://github.com/gradle/github-dependency-graph-gradle-plugin/issues/140) my ask is to add a field to the [JSON body of the submission API](https://docs.github.com/en/rest/dependency-graph/dependency-submission?apiVersion=2022-11-28#create-a-snapshot-of-dependencies-for-a-repository) that can be used to document any failures during dependency resolution.
Because currently, there seems to be no way to indicate to the API that the dependency resolution process that created the JSON might have been unable to resolve some dependencies (maybe due to temporary network issues), and thus the list of submitted dependencies might be incomplete. This is a problem if the user relies on the dependencies and resulting SBOM to be complete. On the other hand, not submitting the dependency graph at all if just a single dependency failed to resolve (maybe also due to misconfiguration on the project side) is probably not a good solution either.
So IMO the best solution is to simply be transparent and allow the dependency resolver to say so if there were any issues in dependency resolution. The GitHub web UI could then show these errors as part of the dependency graph so that he user knows to take the results "with a grain of salt".
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez par la documentation du corps JSON et de la dependency-submission API référencée dans l’issue, puis lisez l’issue associée du Gradle plugin. Déterminez comment les échecs de résolution des dépendances doivent être représentés et signalés afin que les soumissions incomplètes puissent être distinguées ; le travail est terminé lorsque le schéma et le comportement attendu sont convenus et documentés.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- api, backend-api-design
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 30/100