swiftlang / swiftlang/github-workflows

Allow license header check without CONTRIBUTORS.txt line

Open
#267 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
115
Forks
57
Avg merge
1d 8h
Merged PRs (30d)
3

Description

Hi, I wanted to ask about the shared license header check used by the Swift packages.

In apple/swift-log, CONTRIBUTORS.txt was removed as part of the repository cleanup in apple/swift-log#451, following apple/swift-log#450.

I opened a follow-up PR to remove the remaining stale CONTRIBUTORS.txt references from source/test/benchmark file headers:

apple/swift-log#452

However, that PR was closed for now because the shared license header check still expects this line:

// See CONTRIBUTORS.txt for the list of Swift Logging API project authors

Would it be possible to update the shared license header check so repositories can pass without the CONTRIBUTORS.txt line?

This would allow swift-log and similar repositories to remove stale references after deleting CONTRIBUTORS.txt.

Thanks!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the shared license header check used by the Swift packages and compare its handling of the CONTRIBUTORS.txt line with the headers in swift-log's source/test/benchmark files. Review the closed swift-log#452 follow-up and confirm the check can pass after CONTRIBUTORS.txt is removed, without requiring that line.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, swift
Domain
ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.