Skip to content

Add license banner checker for .c/.h files #177

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
casaroli merged 3 commits into from
Feb 20, 2026
Merged

Add license banner checker for .c/.h files #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5745e53
scripts(c_formatting): add license banner checker for .c/.h files
SorinOlari Feb 19, 2026
cc4c3ab
fix: add and modify all license banners for c files
SorinOlari Feb 19, 2026
742584f
ci(formatting-checks): add banner license check
SorinOlari Feb 19, 2026
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
3 changes: 3 additions & 0 deletions .github/workflows/formatting-checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,6 @@ jobs:

- name: Run YAML Format Checks
run: sh scripts/yml_linter.sh

- name: Run Banner License Checks
Copy link
Contributor

@casaroli casaroli Feb 20, 2026

Choose a reason for hiding this comment

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

Suggested change
- name: Run Banner License Checks
- name: License Banner Checks

run: sh scripts/check_license_banner.sh
58 changes: 58 additions & 0 deletions scripts/check_license_banner.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
#!/bin/sh
Copy link
Contributor

@casaroli casaroli Feb 20, 2026

Choose a reason for hiding this comment

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

I think this file should be named check_license_banner_c.sh, because we will have other scripts for other types, but I guess we can rename it in next PRs.

# @copyright Copyright (c) contributors to Project Ocre,
# which has been established as Project Ocre a Series of LF Projects, LLC
#
# SPDX-License-Identifier: Apache-2.0

# Checks all C/C++ files for license banner

set -e

SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
ROOT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
SRC_DIR="$ROOT_DIR/src"

check_license_banner() {
local file="$1"
local file_header

file_header=$(head -n 6 "$file")

# Expected license banner
local expected_banner="/**
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
*/"

if [ "$file_header" != "$expected_banner" ]; then
echo "ERROR: Missing or incorrect license banner in $file"
return 1
fi

return 0
}

echo "Checking license banners."
ERROR_FOUND=0
for file in $(find . -type f \( -name '*.c' -o -name '*.h' \) \
! -name 'utlist.h' \
! -name 'CMakeCCompilerId.c' \
! -path './tests/Unity/*' \
! -path './build/*' \
! -path './wasm-micro-runtime/*' \
! -path './ocre-sdk/*' \
! -path './src/shell/sha256/*' \
! -path './src/runtime/wamr-wasip1/ocre_api/utils/*' \
| sort); do

if ! check_license_banner "$file"; then
ERROR_FOUND=1
fi
done

if [ $ERROR_FOUND -ne 0 ]; then
echo "License check failed."
exit 1
fi
7 changes: 7 additions & 0 deletions src/common/common.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
/**
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
*/

#include <stddef.h>
#include <ctype.h>
#include <string.h>
Expand Down
2 changes: 1 addition & 1 deletion src/platform/zephyr/memory.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/core/core_eventq.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/core/core_external.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/core/core_internal.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/core/core_memory.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/core/core_misc.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/core/core_mutex.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/core/core_timer.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/ocre_api.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/ocre_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
4 changes: 2 additions & 2 deletions src/runtime/wamr-wasip1/ocre_api/ocre_common.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* which has been established as Project Ocre, a Series of LF Projects, LLC
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
*/
Expand Down
4 changes: 2 additions & 2 deletions src/runtime/wamr-wasip1/ocre_api/ocre_common.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-License: Apache-2.0
* SPDX-License-Identifier: Apache-2.0
*/

#ifndef OCRE_COMMON_H
Expand Down
4 changes: 2 additions & 2 deletions src/runtime/wamr-wasip1/ocre_api/ocre_gpio/ocre_gpio.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* which has been established as Project Ocre, a Series of LF Projects, LLC
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
*/
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/ocre_gpio/ocre_gpio.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
6 changes: 3 additions & 3 deletions src/runtime/wamr-wasip1/ocre_api/ocre_messaging/ocre_messaging.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* which has been established as Project Ocre, a Series of LF Projects, LLC
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-License: Apache-2.0
* SPDX-License-Identifier: Apache-2.0
*/

#include <string.h>
Expand Down
6 changes: 3 additions & 3 deletions src/runtime/wamr-wasip1/ocre_api/ocre_messaging/ocre_messaging.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* which has been established as Project Ocre, a Series of LF Projects, LLC
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-License: Apache-2.0
* SPDX-License-Identifier: Apache-2.0
*/

#ifndef OCRE_MESSAGING_H
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/ocre_sensors/ocre_sensors.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/ocre_sensors/ocre_sensors.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/ocre_sensors/rng_sensor.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/ocre_sensors/rng_sensor.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
4 changes: 2 additions & 2 deletions src/runtime/wamr-wasip1/ocre_api/ocre_timers/ocre_timer.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* which has been established as Project Ocre, a Series of LF Projects, LLC
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
*/
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/wamr-wasip1/ocre_api/ocre_timers/ocre_timer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @copyright Copyright © contributors to Project Ocre,
* @copyright Copyright (c) contributors to Project Ocre,
* which has been established as Project Ocre a Series of LF Projects, LLC
*
* SPDX-License-Identifier: Apache-2.0
Expand Down
Loading