Allow leading `swift-tools-version` in `Package.swift` for Licensing check
まだ誰も着手していません。
評価
調査の方向性
まず、soundness workflow のライセンスヘッダーチェックを見つけ、.licenseignore と Package.swift ファイルをどのように処理しているかを確認します。swift-tools-version コメントを含む Package.swift と Package@swift-5.10.swift の例について、ライセンスの前に空行がある場合とない場合の両方でチェックを検証します。すべての要求された形式がマニフェストを無視せずに通れば完了です。
索引モデルが 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."
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時間
- マージ済み PR（30日）
- 3
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
swiftlang/github-workflows のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
swiftlang/github-workflows#305 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
swiftlang/github-workflows#261 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
swiftlang/github-workflows#258 · コメント 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
swiftlang/github-workflows#312 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 58/100
swiftlang/github-workflows#277 · コメント 1 件 ·
swiftlang/github-workflows の issue をすべて見る
似ている issue
-
pending-maintainer-response pending-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
area:build bug good first issue P2
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
uttrflow/uttrflow-swift#1412 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
enhancement
難易度 1/5 1時間未満 初心者へのやさしさ 80/100
-
T-Defect
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
element-hq/element-x-ios#6191 ·