Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Allow leading `swift-tools-version` in `Package.swift` for Licensing check

Abierto
#202 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
swift
Área
ci-cd

Línea de trabajo

Comienza localizando la comprobación del encabezado de licencia del flujo de trabajo de Soundness y revisando cómo gestiona .licenseignore y los archivos Package.swift. Verifica la comprobación con ejemplos de Package.swift y Package@swift-5.10.swift que incluyan el comentario swift-tools-version, tanto con una línea vacía antes de la licencia como sin ella; la tarea está terminada cuando todas las formas solicitadas pasan sin ignorar los manifiestos.

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

Descripción

By convention the first line of a Package.swift manifest is a comment containing the tools version:

"The version is specified on the first line of the manifest with the comment // swift-tools-version: and the version for the Swift compiler."

-Swift Package Manager Documentation

Following this convention causes the license header check of the soundness workflow to fail, even if the tools version is followed by a valid license header.

The approach I have seen taken to work around this, is to add the Package.swift file to the .licenseignore file to allow this test to pass.

Since Package.swift files are almost always present in swiftlang repositories, having license checking automatically work with the documented comment on the first line would allow these files to be more easily checked (or checked at all, instead of ignored).

This should also be allowed in version-specific manifest files such as Package@swift-5.10.swift.

Ideally the check would be able to accept both:

  • First line is swift-tools-version comment
  • License begins on second line

AND

  • First line is swift-tools-version comment
  • Second line is an empty newline
  • License begins on third line

Allowing the tools version to be separated from the license by an empty newline makes it clear the tools version is separate from the license and makes both more easily readable.

Lenguaje dominante
Swift
Estrellas
115
Forks
57
Merge medio
1 d 8 h
PR fusionados (30 d)
3

Guía de contribución

Abrir la 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 swiftlang/github-workflows

Todos los issues de swiftlang/github-workflows

Issues similares

Más issues de Swift

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.