Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DAOS-15677 cq: add copyright GHA and remove required-githooks (#15552)
Add GHA to check for copyright update. Move core logic from update-copyright githook into check_update_copyright.sh so the logic is shared between the githook and GHA. Remove required-githooks watermark since it did not work in all scenarios and the GHA checks are more secure than client-side githooks. Combination of #15552, #15596, #15636, #15639 Skip-build: true Signed-off-by: Dalton Bohning <[email protected]>
- Loading branch information
1 parent
1aeb63e
commit 312236e
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| #!/bin/bash | ||
| # | ||
| # Copyright 2024 Intel Corporation. | ||
| # | ||
| # SPDX-License-Identifier: BSD-2-Clause-Patent | ||
| # | ||
| # Check or update copyright date in modified files. | ||
| # Usage: check_update_copyright.sh <git_target> <githook|gha> | ||
| # mode "githook" will update copyright dates in place. | ||
| # mode "gha" will just print a warning in a GHA-compatible format. | ||
|
|
||
| set -e | ||
|
|
||
| git_target="$1" | ||
| mode="$2" | ||
| case "$mode" in | ||
| "githook" | "gha") | ||
| ;; | ||
| *) | ||
| echo "Usage: check_update_copyright.sh <git_target> <githook|gha>" | ||
| exit 1 | ||
| esac | ||
|
|
||
| # Navigate to repo root | ||
| PARENT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )" | ||
| cd "$PARENT_DIR"/../../ | ||
|
|
||
|
|
||
| regex='(^[[:blank:]]*[\*/]*.*)((Copyright[[:blank:]]*)([0-9]{4})(-([0-9]{4}))?)([[:blank:]]*(Intel.*$))' | ||
| year=$(date +%Y) | ||
| errors=0 | ||
| targets=( | ||
| # Entries with wildcard. These must be first and start with '*' or | ||
| # older versions of git will return files that were not changed. | ||
| '*.c' | ||
| '*.h' | ||
| '*.go' | ||
| '*.py' | ||
| '*.proto' | ||
| '*.java' | ||
| '*.yml' | ||
| '*.yaml' | ||
| '*.sh' | ||
| '*.bash' | ||
| '*Dockerfile*' | ||
| '*README*' | ||
| '*LICENSE*' | ||
| '*NOTICE*' | ||
| '*.txt' | ||
| '*.md' | ||
| # Entries without a wildcard | ||
| 'Makefile' | ||
| 'Jenkinsfile' | ||
| 'SConscript' | ||
| 'SConstruct' | ||
| 'copyright' | ||
| '.env' | ||
| ) | ||
|
|
||
| if [ -z "$files" ]; then | ||
| files=$(git diff "$git_target" --cached --diff-filter=AM --name-only -- "${targets[@]}") | ||
| else | ||
| echo " Checking against custom files" | ||
| fi | ||
|
|
||
| os=$(uname -s) | ||
|
|
||
| . utils/githooks/git-version.sh | ||
|
|
||
| for file in $files; do | ||
| if [[ "$file" == *vendor* ]] || [[ "$file" == *pb.go ]] || | ||
| [[ "$file" == *_string.go ]] || [[ "$file" == *pb-c* ]] || | ||
| { [ "$mode" == "githook" ] && | ||
| [ "$git_vercode" -ge 2030000 ] && | ||
| [ "$(git diff --cached -I Copyright "$file")" = '' ]; }; then | ||
| continue | ||
| fi | ||
| read -r y1 y2 <<< "$(sed -nre "s/^.*$regex.*$/\4 \6/p" "$file")" | ||
| if [[ -z $y1 ]] ; then | ||
| # Print warning but don't error on non-existent copyright | ||
| echo " Copyright Information not found in: $file" | ||
| elif [[ $y1 -ne $year && $year -ne $y2 ]] ; then | ||
| if [[ "$mode" == "githook" ]]; then | ||
| # Update copyright in place | ||
| if ! git reset "$file"; then | ||
| echo " Unable to un-stage $file" | ||
| errors=$((errors + 1)) | ||
| fi | ||
| if [[ "$os" == 'Linux' ]]; then | ||
| sed -i -re "s/$regex/\1Copyright $y1-$year \8/" "$file" | ||
| else | ||
| sed -i '' -re "s/$regex/\1Copyright $y1-$year \8/" "$file" | ||
| fi | ||
|
|
||
| if ! git add "$file"; then | ||
| echo " Unable to re-stage $file" | ||
| errors=$((errors + 1)) | ||
| fi | ||
| elif [[ "$mode" == "gha" ]]; then | ||
| # Print error but do not update | ||
| lineno="$(grep -nE "$regex" "$file" | cut -f1 -d:)" | ||
| echo "::error file=$file,line=$lineno::Copyright out of date" | ||
| errors=$((errors + 1)) | ||
| fi | ||
| fi | ||
| done | ||
|
|
||
| if [[ $errors -ne 0 ]]; then | ||
| echo " $errors errors while checking/fixing copyrights." | ||
| exit 1 | ||
| fi |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -54,9 +54,3 @@ run-parts() { | |
| } | ||
|
|
||
| run-parts utils/githooks/"${hook}".d "$@" 1>&2 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| #!/bin/bash | ||
| # | ||
| # Copyright 2022-2024 Intel Corporation. | ||
| # | ||
| # SPDX-License-Identifier: BSD-2-Clause-Patent | ||
| # | ||
| # A git hook to validate and correct the copyright date in source files. | ||
|
|
||
| _print_githook_header "Copyright" | ||
| if [ -e .git/MERGE_HEAD ]; then | ||
| echo "Merge commit. Skipping" | ||
| exit 0 | ||
| fi | ||
|
|
||
| echo "Updating copyright headers" | ||
|
|
||
| utils/cq/check_update_copyright.sh "$TARGET" githook |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.