swiftlang / swiftlang/github-workflows

Shell license checks should not check the shebang (`#!`)

Open
#237 0 comments 1 reaction 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

The license header GHA fails, unnecessarily, with the following:

❯ ../github-workflows/.github/workflows/scripts/check-license-header.sh 
--- Expected header
+++ .devcontainer/init.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/sh -x
 ##===----------------------------------------------------------------------===##
 ##
 ## This source file is part of the Swift open source project

It is wrong, and too restrictive, to have the "shebang" cause a license check violation.

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 with .github/workflows/scripts/check-license-header.sh and reproduce the failure against .devcontainer/init.sh. Confirm that the license check no longer treats the shebang as a header violation while still checking the remaining license header.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, shell
Domain
ci-cd
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.