Skip to content

Fix license header check ignoring well known files #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 17, 2024
Merged

Fix license header check ignoring well known files #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions .github/workflows/scripts/check-broken-symlinks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
#!/bin/bash
# ===----------------------------------------------------------------------===//
#
# This source file is part of the Swift.org open source project
#
# Copyright (c) 2024 Apple Inc. and the Swift project authors
# Licensed under Apache License v2.0 with Runtime Library Exception
#
# See https://swift.org/LICENSE.txt for license information
# See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
#
# ===----------------------------------------------------------------------===//
## ===----------------------------------------------------------------------===##
##
## This source file is part of the Swift.org open source project
##
## Copyright (c) 2024 Apple Inc. and the Swift project authors
## Licensed under Apache License v2.0 with Runtime Library Exception
##
## See https://swift.org/LICENSE.txt for license information
## See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
##
## ===----------------------------------------------------------------------===##

set -euo pipefail

Expand Down
22 changes: 11 additions & 11 deletions .github/workflows/scripts/check-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
#!/bin/bash
# ===----------------------------------------------------------------------===//
#
# This source file is part of the Swift.org open source project
#
# Copyright (c) 2024 Apple Inc. and the Swift project authors
# Licensed under Apache License v2.0 with Runtime Library Exception
#
# See https://swift.org/LICENSE.txt for license information
# See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
#
# ===----------------------------------------------------------------------===//
## ===----------------------------------------------------------------------===##
##
## This source file is part of the Swift.org open source project
##
## Copyright (c) 2024 Apple Inc. and the Swift project authors
## Licensed under Apache License v2.0 with Runtime Library Exception
##
## See https://swift.org/LICENSE.txt for license information
## See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
##
## ===----------------------------------------------------------------------===##

set -euo pipefail

Expand Down
32 changes: 16 additions & 16 deletions .github/workflows/scripts/check-license-header.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
#!/bin/bash
# ===----------------------------------------------------------------------===//
#
# This source file is part of the Swift.org open source project
#
# Copyright (c) 2024 Apple Inc. and the Swift project authors
# Licensed under Apache License v2.0 with Runtime Library Exception
#
# See https://swift.org/LICENSE.txt for license information
# See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
#
# ===----------------------------------------------------------------------===//
## ===----------------------------------------------------------------------===##
##
## This source file is part of the Swift.org open source project
##
## Copyright (c) 2024 Apple Inc. and the Swift project authors
## Licensed under Apache License v2.0 with Runtime Library Exception
##
## See https://swift.org/LICENSE.txt for license information
## See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
##
## ===----------------------------------------------------------------------===##

set -euo pipefail

Expand Down Expand Up @@ -40,12 +40,12 @@ fi

paths_with_missing_license=( )

file_excludes=".license_header_template
.licenseignore"
if [ -f .licenseignore ]; then
file_excludes=$file_excludes$(printf '\n')$(cat .licenseignore)
if [[ -f .licenseignore ]]; then
file_paths=$(tr '\n' '\0' < .licenseignore | xargs -0 -I% printf '":(exclude)%" '| xargs git ls-files ":(exclude).licenseignore" ":(exclude).license_header_template" )
else
file_paths=$(git ls-files ":(exclude).license_header_template" )
fi
Comment on lines +43 to 47
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The second xargs confused me a little bit until I realized that it only causes git ls-files to be called a single time. Maybe worth pulling out the computation of the exclude list to make it more readable? Something along the lines of the following.

Suggested change
if [[ -f .licenseignore ]]; then
file_paths=$(tr '\n' '\0' < .licenseignore | xargs -0 -I% printf '":(exclude)%" '| xargs git ls-files ":(exclude).licenseignore" ":(exclude).license_header_template" )
else
file_paths=$(git ls-files ":(exclude).license_header_template" )
fi
if [[ -f .licenseignore ]]; then
exclude_list="':(exclude).licenseignore' ':(exclude).license_header_template' $($(tr '\n' '\0' < .licenseignore | xargs -0 -I% printf '":(exclude)%")"
else
exclude_list=":(exclude).license_header_template"
fi
file_paths=$(git ls-files $exclude_list)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree though I would prefer a follow up PR to unblock the CI on other repos

file_paths=$(echo "$file_excludes" | tr '\n' '\0' | xargs -0 -I% printf '":(exclude)%" '| xargs git ls-files)


while IFS= read -r file_path; do
file_basename=$(basename -- "${file_path}")
Expand Down
22 changes: 11 additions & 11 deletions .github/workflows/scripts/check-swift-format.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
#!/bin/bash
# ===----------------------------------------------------------------------===//
#
# This source file is part of the Swift.org open source project
#
# Copyright (c) 2024 Apple Inc. and the Swift project authors
# Licensed under Apache License v2.0 with Runtime Library Exception
#
# See https://swift.org/LICENSE.txt for license information
# See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
#
# ===----------------------------------------------------------------------===//
## ===----------------------------------------------------------------------===##
##
## This source file is part of the Swift.org open source project
##
## Copyright (c) 2024 Apple Inc. and the Swift project authors
## Licensed under Apache License v2.0 with Runtime Library Exception
##
## See https://swift.org/LICENSE.txt for license information
## See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
##
## ===----------------------------------------------------------------------===##

set -euo pipefail

Expand Down
22 changes: 11 additions & 11 deletions .github/workflows/scripts/check-unacceptable-language.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
#!/bin/bash
# ===----------------------------------------------------------------------===//
#
# This source file is part of the Swift.org open source project
#
# Copyright (c) 2024 Apple Inc. and the Swift project authors
# Licensed under Apache License v2.0 with Runtime Library Exception
#
# See https://swift.org/LICENSE.txt for license information
# See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
#
# ===----------------------------------------------------------------------===//
## ===----------------------------------------------------------------------===##
##
## This source file is part of the Swift.org open source project
##
## Copyright (c) 2024 Apple Inc. and the Swift project authors
## Licensed under Apache License v2.0 with Runtime Library Exception
##
## See https://swift.org/LICENSE.txt for license information
## See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
##
## ===----------------------------------------------------------------------===##

set -euo pipefail

Expand Down
11 changes: 11 additions & 0 deletions .license_header_template
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## ===----------------------------------------------------------------------===##
##
## This source file is part of the Swift.org open source project
##
## Copyright (c) YEARS Apple Inc. and the Swift project authors
## Licensed under Apache License v2.0 with Runtime Library Exception
##
## See https://swift.org/LICENSE.txt for license information
## See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
##
## ===----------------------------------------------------------------------===##
5 changes: 5 additions & 0 deletions .licenseignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.github/workflows/configs/.flake8
**/*.yml
CODEOWNERS
LICENSE.txt
README.md
14 changes: 6 additions & 8 deletions tests/test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
#!/usr/bin/env python3
##===----------------------------------------------------------------------===##
## ===----------------------------------------------------------------------===##
##
## This source file is part of the Swift.org open source project
##
## Copyright (c) 2020 Apple Inc. and the Swift.org project authors
## Licensed under Apache License v2.0
## Copyright (c) 2024 Apple Inc. and the Swift project authors
## Licensed under Apache License v2.0 with Runtime Library Exception
##
## See LICENSE.txt for license information
## See CONTRIBUTORS.txt for the list of Swift.org project authors
## See https://swift.org/LICENSE.txt for license information
## See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
##
## SPDX-License-Identifier: Apache-2.0
##
##===----------------------------------------------------------------------===##
## ===----------------------------------------------------------------------===##