diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b589f801..20064b29 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -100,3 +100,20 @@ jobs: cmake -S . -B build_unit_test -GNinja -DOPT_ENABLE_COVERAGE=ON cmake --build build_unit_test ctest --test-dir build_unit_test --output-on-failure + + dco-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: Check commits for DCO + run: | + set -eo pipefail + git rev-list --no-merges origin/main..HEAD | while read -r rev; do + if ! git show "$rev" --pretty=format:%B --no-patch \ + | grep -qE '^Signed-off-by: [A-Za-z0-9 ._-]+ <[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}>[[:space:]]*$'; then + echo "Commit $rev has a missing or malformed 'Signed-off-by' footer." >&2 + exit 1 + fi + done diff --git a/README.md b/README.md index 84cf49f8..4dca237c 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ for Armv8-M, Armv8.1-M architectures (e.g. the Cortex-M33, Cortex-M23, Cortex-M55, Cortex-M85 processors) and dual-core platforms. It is the platform security architecture reference implementation aligning with PSA Certified guidelines, enabling chips, Real Time Operating Systems and devices to become -PSA Certified. Follow the [link](https://tf-m-user-guide.trustedfirmware.org/introduction/readme.html) +PSA Certified. Follow the [link](https://trustedfirmware-m.readthedocs.io/en/latest/introduction/readme.html) for more information on Trusted Firmware M. To have a better overview of how Trusted Firmware M is integrated with the FRI project, you're kindly asked to check [Trusted Firmware M component document](docs/components/security/trusted_firmware-m/trusted_firmware-m.md) ### Mbed TLS diff --git a/docs/components/security/trusted_firmware-m/trusted_firmware-m.md b/docs/components/security/trusted_firmware-m/trusted_firmware-m.md index 0d7149f6..880f6195 100644 --- a/docs/components/security/trusted_firmware-m/trusted_firmware-m.md +++ b/docs/components/security/trusted_firmware-m/trusted_firmware-m.md @@ -143,7 +143,7 @@ For more details of how to use Trusted Firmware-M, see its [official documentati If you encounter any issues or have questions regarding the integration of Trusted Firmware M into your IoT project, feel free to reach out to the Arm support community or consult the official documentation for assistance. -[Configuration]: https://tf-m-user-guide.trustedfirmware.org/configuration -[official documentation]: https://tf-m-user-guide.trustedfirmware.org/ -[TF-M Platforms]: https://tf-m-user-guide.trustedfirmware.org/platform +[Configuration]: https://trustedfirmware-m.readthedocs.io/en/latest/configuration/index.html +[official documentation]: https://trustedfirmware-m.readthedocs.io/en/latest/index.html +[TF-M Platforms]: https://trustedfirmware-m.readthedocs.io/en/latest/platform/index.html [Trusted Firmware-M]: https://www.trustedfirmware.org/projects/tf-m/ diff --git a/docs/development_environment/linux_dev_env.md b/docs/development_environment/linux_dev_env.md index 657e6ec3..8a474a76 100644 --- a/docs/development_environment/linux_dev_env.md +++ b/docs/development_environment/linux_dev_env.md @@ -34,7 +34,7 @@ ```bash sudo apt install python3-pip -y - python3 -m pip install ninja imgtool cffi intelhex cbor2 jinja2 PyYaml pyelftools click pyhsslms cbor cmake setuptools wheel + python3 -m pip install ninja imgtool cffi intelhex cbor2 jinja2 PyYaml pyelftools click pyhsslms cbor cmake setuptools wheel clang==14.0 rich ``` **NOTE**: The virtual environment can be deactivated when not needed anymore @@ -46,8 +46,8 @@ * Installing required libraries ```bash - sudo apt install srecord - sudo apt install binutils + sudo apt install srecord binutils libsndfile1-dev libclang-14-dev + echo LD_LIBRARY_PATH=\"/usr/lib/llvm-14/lib:\$LD_LIBRARY_PATH\" >> ~/.bashrc ``` * Installing a toolchain diff --git a/release_changes/202506091030.change.md b/release_changes/202506091030.change.md new file mode 100644 index 00000000..dd648fd6 --- /dev/null +++ b/release_changes/202506091030.change.md @@ -0,0 +1,3 @@ +github-ci: Add DCO sign-off enforcement workflow +docs: Redirect TF-M links to Read the Docs URLs +docs: Add the missing development environment requirements