fix noncompliant copyright/license files; add reuse compliance badge,…

… github action, pre-commit hook related to #18 Signed-off-by: Kevin Broch <[email protected]>
rivosinc · May 22, 2023 · 4eaa49b · 4eaa49b
1 parent 18febaf
commit 4eaa49b
Show file tree

Hide file tree

Showing 10 changed files with 56 additions and 27 deletions.
diff --git a/.github/workflows/reuse.yml b/.github/workflows/reuse.yml
@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2023 Rivos Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+name: reuse
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: reuse Compliance Check
+      uses: fsfe/reuse-action@v1
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2023 Rivos Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
 name: Rust
 
 on:

diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2023 Rivos Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
 target/
 **/*.rs.bk
 **/*.sw[po]

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2023 Rivos Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+repos:
+  # pull mirror of https://github.com/fsfe/reuse-tool
+  - repo: https://github.com/rivosinc/reuse-tool
+    rev: '91c61b9b5f85d4f0023cb780dad635cc6ff08afa'
+    hooks:
+      # Check compliance
+      - id: reuse
diff --git a/BUILD b/BUILD
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2023 Rivos Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
 package(default_visibility = ["//visibility:public"])
 
 load("@rules_rust//rust:defs.bzl", "rust_clippy", "rust_library", "rustfmt_test")

diff --git a/LICENSES/LicenseRef-ChromiumOS-BSD-style.txt b/LICENSES/LicenseRef-ChromiumOS-BSD-style.txt
diff --git a/README.md b/README.md
@@ -1,5 +1,13 @@
+<!--
+SPDX-FileCopyrightText: 2023 Rivos Inc.
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
 # Overview
 
+[![REUSE status](https://api.reuse.software/badge/github.com/rivosinc/sbi-rs)](https://api.reuse.software/info/github.com/rivosinc/sbi-rs)
+
 This crate provides interfaces for both implementing(firmware or hypervisor)
 and using(S and VS mode supervisors)
 [SBI](https://github.com/riscv-non-isa/riscv-sbi-doc/releases) functionality.

diff --git a/bazel-locks/Sbi-Cargo.Bazel.lock.license b/bazel-locks/Sbi-Cargo.Bazel.lock.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Rivos Inc.
+
+SPDX-License-Identifier: Apache-2.0
diff --git a/bazel-locks/sbi-cargo-bazel-lock.json.license b/bazel-locks/sbi-cargo-bazel-lock.json.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2023 Rivos Inc.
+
+SPDX-License-Identifier: Apache-2.0
diff --git a/deps.bzl b/deps.bzl
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2023 Rivos Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
 load("@rules_rust//crate_universe:defs.bzl", "crate", "crates_repository")
 
 # on changes to crate depdencies, run the following command:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		SPDX-FileCopyrightText: 2023 Rivos Inc.

		SPDX-License-Identifier: Apache-2.0