Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Add an API diff workflow

Aperta
#155 2 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
github-actions, swift
Ambito
api, ci-cd

Direzione di ricerca

Inizia leggendo il workflow esistente per le API breakage e traccia come viene eseguito sulle pull request. Determina come ottenere il diff di swiftinterface, o un equivalente per i package senza library evolution, e confronta la possibilità di presentarlo come commento alla PR rispetto all’output di un GitHub check. Il lavoro è completato quando il workflow rende visibile il diff dell’API e supporta la configurazione dei moduli da includere.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Swift
Stelle
115
Fork
57
Merge medio
1g 8h
PR unite (30g)
3

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di swiftlang/github-workflows

Tutte le issue di swiftlang/github-workflows

Issue simili

Altre issue su Swift

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.