Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
#202 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
45/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
swift
领域
ci-cd

调研方向

首先定位 soundness workflow 的许可证头检查,并查看它如何处理 .licenseignore 和 Package.swift 文件。使用包含 swift-tools-version 注释的 Package.swift 和 Package@swift-5.10.swift 示例验证该检查,分别测试许可证前有空行和没有空行的情况;完成的标准是所有要求的形式都能通过,且不会忽略这些 manifest。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Swift
星标
115
派生
57
平均合并
1 天 8 小时
30 天内合并 PR
3

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

swiftlang/github-workflows 的其他 Issue

查看 swiftlang/github-workflows 的全部 Issue

相似的 Issue

更多 Swift Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。