Minimal ci (#3)

- [x] Setup minimal Rust workflow for linting, tests, build
- [x] Add a workflow for license / license header checking
- [x] Apply fixes for failing actions

---------

Signed-off-by: Marvin Gudel <[email protected]>

Author: embediver

.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: Lint, Build and Test
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+     - uses: actions/checkout@v4
+     - name: Install Rust (stable) with components
+       uses: dtolnay/rust-toolchain@stable
+       with:
+        components: clippy, rustfmt
+     - name: Cache cargo registry and build
+       uses: Swatinem/rust-cache@v2
+     - name: rustfmt check
+       run: cargo fmt --all -- --check
+     - name: clippy (deny warnings)
+       run: |
+         cargo clippy --all-targets --all-features -- -D warnings
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install Rust (stable) with components
+      uses: dtolnay/rust-toolchain@stable
+    - name: Cache cargo registry and build
+      uses: Swatinem/rust-cache@v2
+    - name: Cargo Build
+      run: cargo build --verbose
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install Rust (stable) with components
+      uses: dtolnay/rust-toolchain@stable
+    - name: Cache cargo registry and build
+      uses: Swatinem/rust-cache@v2
+    - name: Run tests
+      run: cargo test --all-features --verbose

.github/workflows/license.yml

@@ -0,0 +1,11 @@
+name: License Check
+
+on: pull_request
+
+jobs:
+  license:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: License Eye Header
+        uses: apache/[email protected]

.gitignore

@@ -0,0 +1,2 @@
+target/
+Cargo.lock

.licenserc.yaml

@@ -0,0 +1,12 @@
+header:
+  license:
+    spdx-id: Apache-2.0
+    # No copyright owner until this has been clarified
+    # copyright-owner: OpenPRoT a Series of LF Projects, LLC
+    copyright-year: 2025
+    software-name: pldm-lib
+
+  paths:
+    - '**/*.rs'
+
+  comment: on-failure

src/codec.rs

@@ -1,4 +1,16 @@
-// Licensed under the Apache-2.0 license
+// Copyright 2025
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
 use zerocopy::{FromBytes, Immutable, IntoBytes};
 

src/error.rs

@@ -1,4 +1,16 @@
-// Licensed under the Apache-2.0 license
+// Copyright 2025
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
 #[derive(Debug, Clone, PartialEq)]
 pub enum PldmError {

src/lib.rs

@@ -1,4 +1,16 @@
-// Licensed under the Apache-2.0 license
+// Copyright 2025
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
 #![cfg_attr(target_arch = "riscv32", no_std)]
 

src/message/control.rs

@@ -1,9 +1,21 @@
-// Licensed under the Apache-2.0 license
+// Copyright 2025
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
 use crate::error::PldmError;
 use crate::protocol::base::{
-    InstanceId, PldmControlCmd, PldmMsgHeader, PldmMsgType, PldmSupportedType,
-    TransferOperationFlag, TransferRespFlag, PLDM_MSG_HEADER_LEN,
+    InstanceId, PLDM_MSG_HEADER_LEN, PldmControlCmd, PldmMsgHeader, PldmMsgType, PldmSupportedType,
+    TransferOperationFlag, TransferRespFlag,
 };
 use crate::protocol::version::{PldmVersion, ProtocolVersionStr, Ver32};
 use zerocopy::{FromBytes, Immutable, IntoBytes};

src/message/firmware_update/activate_fw.rs

@@ -1,7 +1,19 @@
-// Licensed under the Apache-2.0 license
+// Copyright 2025
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
 use crate::protocol::base::{
-    InstanceId, PldmMsgHeader, PldmMsgType, PldmSupportedType, PLDM_MSG_HEADER_LEN,
+    InstanceId, PLDM_MSG_HEADER_LEN, PldmMsgHeader, PldmMsgType, PldmSupportedType,
 };
 use crate::protocol::firmware_update::FwUpdateCmd;
 use zerocopy::{FromBytes, Immutable, IntoBytes};

src/message/firmware_update/apply_complete.rs

@@ -1,8 +1,20 @@
-// Licensed under the Apache-2.0 license
+// Copyright 2025
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
 use crate::error::PldmError;
 use crate::protocol::base::{
-    InstanceId, PldmMsgHeader, PldmMsgType, PldmSupportedType, PLDM_MSG_HEADER_LEN,
+    InstanceId, PLDM_MSG_HEADER_LEN, PldmMsgHeader, PldmMsgType, PldmSupportedType,
 };
 use crate::protocol::firmware_update::{ComponentActivationMethods, FwUpdateCmd};
 use zerocopy::{FromBytes, Immutable, IntoBytes};