connectors: carry the NOTICE content of bundled crates into the fat iggy-connect image

Aperta
  • Qualcosa non va?
#4,748 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
docker, github-actions, rust
Ambito
build-system, documentation, release

Direzione di ricerca

First confirm that #4533 has merged and review its full crate list; the issue says work before then may be incomplete. Read core/connectors/runtime/Dockerfile, about.hbs, and scripts/ci/third-party-licenses.sh to understand how the manifest and fat image are built. Decide where to collect and ship bundled crate NOTICE content, check whether the slim image is affected, and get a PMC member to review the legal text.

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

Descrizione

CI/CD connectors
Description

This issue is valid only after #4533 is merged. It depends on the crate list that PR produces: the connectors runtime plus every connector plugin. Work started before the merge can use an incomplete list.

The fat apache/iggy-connect image bundles many third-party crates. Some of them ship their own NOTICE file, for example parquet, arrow-array, object_store (NOTICE.txt), and iceberg, apache-avro (NOTICE).

The image carries only the repository NOTICE, which core/connectors/runtime/Dockerfile copies to /usr/share/doc/iggy-connect/. The generated LICENSE-binary comes from about.hbs. That template prints license names, the crates that use each license, and the license text. It does not print NOTICE content.

ASF policy requires that the NOTICE content of bundled Apache-2.0 software reaches the distribution. The fat image does not do this today. The fat image must ship the NOTICE content of every bundled crate that has one, taken from the full crate list and not from the plugins alone.

Raised in the review of #4533 (https://github.com/apache/iggy/pull/4533), comment on core/connectors/runtime/Dockerfile. The reviewer agreed that this can be a follow-up.

Affected area / component

Connectors, CI / build / tooling

Proposed solution

Collect the NOTICE files of the bundled crates when the license manifest is generated, and ship their content in the fat image. Open points:

  • Does the content go into the shipped NOTICE file, or into a separate file next to it?
  • Does the slim image need the same change for the runtime crates?
  • Which tool collects the NOTICE files: cargo-about, or a step in scripts/ci/third-party-licenses.sh?
  • A PMC member must review the result, because it is legal text.
Alternatives considered

Leave the NOTICE content out and document the gap. This does not meet the ASF policy, so it is not an option for a release.

Contribution
  • I'm willing to submit a pull request to implement this feature
Good first issue
  • I think this could be a good first issue for a new contributor
Lingua principale
Rust
Stelle
5.2k
Fork
516
Merge medio
2g 17h
PR unite (30g)
155

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

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 apache/iggy

Tutte le issue di apache/iggy

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.