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

Render ASF LICENSE and DEPENDENCIES files from SPDX license data

Aperta
  • Qualcosa non va?
#322 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à
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
java
Ambito
build-system, documentation

Direzione di ricerca

The issue points to three linked PRs (#319–#321) and the LICENSE and DEPENDENCIES templates in apache/maven-apache-resources. First check those PRs and how the templates use $spdx.preferred and $spdx.unresolved; then identify the remaining work for headings, stable per-license file names, and rendering ASF resource bundles. Done means the templates use SPDX data while retaining declared license names for unresolved dependencies.

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

Descrizione

enhancement

#316 gives templates an SPDX ID and a preferred license per dependency (#319, #320, #321). This issue tracks what the plugin still needs so that ASF bundles can render LICENSE and DEPENDENCIES files from it.

Plan

Each item is its own PR, linked here.

  1. Headings and file names. Add $spdx.title($id) for a heading such as "BSD 3-Clause License", and a stable file name per ID for templates that point at per-license text files, as Spark's LICENSE-binary does with its licenses-binary/ directory. The texts stay with each project.
  2. ASF resource bundles. Once a release contains #319 to #321, use $spdx.preferred in the DEPENDENCIES and LICENSE templates of apache/maven-apache-resources, keeping the declared license names for dependencies that $spdx.unresolved returns.

Out of scope

  • Checking LICENSE against what a distribution bundles. The licensing how-to scopes LICENSE to the distribution: "Do not add to LICENSE and NOTICE dependencies which are not in the distribution. Only bundled bits matter" (licensing-howto). A check of that has to read the built artifact, as Kafka verify_license.py, Pulsar CheckBinaryLicenseTask.kt and Flink's JarFileChecker.java do. This plugin renders before packaging. To narrow $projects to what a module bundles, use the existing includeGroupIds, excludeArtifactIds and scope filters.
  • Failing the build on a license. The License Maven Plugin has failOnBlacklist and include and exclude lists, and its master adds forbidden and problematic license classes (LicenseClassifier.java, since 2.8.0, unreleased as of 2.7.1).
  • NOTICE aggregation. The shade plugin's ApacheNoticeResourceTransformer already merges bundled NOTICE files.
Lingua principale
Java
Stelle
17
Fork
20
Merge medio
12h 3m
PR unite (30g)
22

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna 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 apache/maven-remote-resources-plugin

Tutte le issue di apache/maven-remote-resources-plugin

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.