Add license banner checker for .md files

.github/CODE_OF_CONDUCT.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Code of Conduct
 
 Ocre is a project of Linux Foundation Edge and applies the [LF Edge Contributor Code of Conduct](https://www.lfedge.org/governance/code-of-conduct/).

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Description
 
 Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

.github/workflows/formatting-checks.yml

@@ -44,3 +44,6 @@ jobs:
 
       - name: License Banner Checks(conf files)
         run: sh scripts/check_license_banner_conf_files.sh
+
+      - name: License Banner Checks(md files)
+        run: sh scripts/check_license_banner_md.sh

CONTRIBUTING.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Contributing to Ocre 
 
 The Ocre community shares the spirit of the [Apache Way](https://apache.org/theapacheway/)

MAINTAINERS.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Maintainers
 
 This page lists all active maintainers (also known as committers) of the [Ocre Project](https://www.lfedge.org/projects/ocre/), which includes this repository and the [Ocre Project Documentation Repo](https://github.com/project-ocre/project-ocre.github.io).

README.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 ![Ocre logo](ocre_logo.jpg "Ocre")
 
 # Ocre

SECURITY.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Security Policy
 
 ## Reporting a Vulnerability

docs/AddZephyrBoard.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Adding support for Zephyr boards
 
 This document will guide you through the process of adding support for Zephyr boards to Ocre.

docs/BuildSystemLinux.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Ocre Build System for Linux
 
 Ocre build system is based on CMake. This provides an easy way of embedding Ocre in diffrerent Linux applications,

docs/BuildSystemZephyr.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Ocre Build System for Zephyr
 
 Ocre build system is tightly integrated with Zephyr's build system, allowing developers to leverage the power of Zephyr's build system while also providing a more streamlined and user-friendly experience for developing Ocre itself.

docs/CreateAndRunCustomContainer.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Create and Run Custom Container
 
 This guide will walk you through the process of creating and running a custom Ocre container on your board.

docs/CustomZephyrApplication.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 ## Adding Ocre Zephyr module to a custom Zephyr application
 
 Ocre comes with a few samples to get you going fast:

docs/Devcontainers.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Devcontainers
 
 Devcontainers are tools that allows you to create and manage isolated development environments in containers. It provides a consistent and reproducible development environment across different machines and operating systems.

docs/EmbeddingOcre.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Add Ocre Runtime to a custom Linux Application
 
 This document will guide you through the process of embedding Ocre Runtime into a custom Linux application. For integrating Ocre Runtime into a Zephyr application, please refer to the [Custom Zephyr Application](CustomZephyrApplication.md) documentation.

docs/GetStartedLinux.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Get Started with Linux
 
 The samples we currently provide for Linux are the following. Check their specific instruction for

docs/GetStartedZephyr.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Get Started with Zephyr
 
 The samples we currently provide for Zephyr are the following. Check their specific instruction for

docs/NativeBuild.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Set up host to build Ocre
 
 This document provides instructions on how to build the Ocre Runtime from source without requiring Docker. These instructions also work inside a docker container, however this is provided as a reference for whose who need the development enviroment available in the host.

docs/OcreCli.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Ocre CLI
 
 The ocre command line interface (CLI) is a powerful tool for interacting with the Ocre runtime. It provides a simple and intuitive way to manage and execute images within the Ocre environment.

docs/Platform.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Ocre Runtime platform requirements
 
 Ocre targets a POSIX-like operating system and makes heavy use of the POSIX API.

docs/PlatformPosix.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # POSIX Platform
 
 In Linux, pthreads are enabled by compiling with `-pthread` and linking with `-lpthread`. This might not be required for other POSIX platforms. The required build flags are automatically selected by the cmake build system.

docs/PlatformZephyr.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Zephyr Platform
 
 In Zephyr, the POSIX API is selected by the `CONFIG_POSIX_API` configuration option.

docs/StateInformation.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # State information directory
 
 ## Location

docs/Versioning.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Ocre Versioning
 
 ## Source components

docs/boards/zephyr/b_u585i_iot02a.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Zephyr Board: `b_u585i_iot02a`
 
 The [Discovery Kit for IoT Node with STM32U5 Series](https://www.st.com/en/evaluation-tools/b-u585i-iot02a.html) is a demonstration and development board featuring the **STM32U585AIUx** MCU.

docs/boards/zephyr/native_sim.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Zephyr Board: `native_sim`
 
 The **native_sim** board is a simulated Zephyr target that runs on your host Linux machine. It allows you to develop and test Zephyr applications without needing physical hardware. The native_sim board is particularly useful for rapid iteration, testing, and debugging.

docs/samples/demo.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # demo sample
 
 The demo sample will run a few scenarios in a sequential demonstration.

docs/samples/mini.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # mini sample
 
 This sample will create `hello-world.wasm` from the state information directory (`/lfs/ocre/images/hellow-world.wasm` if it does not exist. Then it will execute this container, which prints a nice ASCII art.

docs/samples/supervisor.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Supervisor
 
 The Supervisor will run "ocre daemon" in background, being controlled by the ocre-cli command line (shell) tool. It by default will preload the following images,

docs/tests/CoverageReports.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Source code test coverage reports
 
 The source code coverage report generation coverage mapping features provided in clang

docs/tests/LeakChecks.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # Memory leak checks
 
 The memory leak checks will leverage the address sanitizer features provided in clang

docs/tests/SystemTests.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 # System tests
 
 System Tests are tests designed to test the entire system as a black box,

scripts/check_license_banner_md.sh

@@ -0,0 +1,53 @@
+#!/bin/sh
+# @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 .md 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 4 "$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 '*.md' \) \
+    ! -path './tests/Unity/*' \
+    ! -path './build/*' \
+    ! -path './wasm-micro-runtime/*' \
+    ! -path './ocre-sdk/*' \
+    ! -path './.github/ISSUE_TEMPLATE*' \
+    | 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

tests_hw/README.md

@@ -1,3 +1,8 @@
+<!-- @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 -->
+
 ## Overview
 
 In the Ocre testing framework, the Ocre execution is comprised of test groups, test suites, and test cases.