Render ASF LICENSE and DEPENDENCIES files from SPDX license data

Abierto
  • ¿Algo no está bien?
#322 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
java
Área
build-system, documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
Java
Estrellas
16
Forks
20
Merge medio
12 h 3 min
PR fusionados (30 d)
22

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de apache/maven-remote-resources-plugin

Todos los issues de apache/maven-remote-resources-plugin

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.