chore: add reuse config & licensing

telekom · Jan 13, 2025 · a1173b3 · a1173b3
1 parent 7f51e93
commit a1173b3
Show file tree

Hide file tree

Showing 135 changed files with 400 additions and 1,284 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: CC-BY-4.0
+
 name: Bug report
 description: File a bug/issue
 title: "Bug: "

diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: CC-BY-4.0
+
 name: Feature request
 description: Suggest an idea for this project
 title: "Feature: "

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: CC-BY-4.0
+
 version: 2
 updates:
   - package-ecosystem: "gomod"

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
 ## Motivation
 
 <!-- Explain what motivated you to do these changes -->

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 name: Continuous Integration
 
 on:

diff --git a/.github/workflows/e2e_checks.yml b/.github/workflows/e2e_checks.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 name: E2E - Test checks
 
 on:

diff --git a/.github/workflows/end2end.yml b/.github/workflows/end2end.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # This workflow installs 1 instance of sparrow and
 # verify the API output
 

diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 name: pre-commit.ci
 
 on: [pull_request]

diff --git a/.github/workflows/prune.yml b/.github/workflows/prune.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 name: Prune GHCR
 
 on:

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 name: Release
 
 on:

diff --git a/.github/workflows/test_sast.yml b/.github/workflows/test_sast.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 name: Test - SAST
 
 on:

diff --git a/.github/workflows/test_unit.yml b/.github/workflows/test_unit.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 name: Test - Unit
 
 on:

diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # If you prefer the allow list template instead of the deny list, see community template:
 # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
 #

diff --git a/.golangci.yaml b/.golangci.yaml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # yaml-language-server: $schema=https://golangci-lint.run/jsonschema/golangci.jsonschema.json
 linters-settings:
   depguard:

diff --git a/.goreleaser-ci.yaml b/.goreleaser-ci.yaml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 project_name: sparrow
 snapshot:
   name_template: "commit-{{ .ShortCommit }}"

diff --git a/.goreleaser.yaml b/.goreleaser.yaml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 project_name: sparrow
 builds:
   - env: [CGO_ENABLED=0]

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 repos:
   - repo: local
     hooks:

diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1 +1,5 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 * @y-eight @NiklasTreml @puffitos @lvlcn-t
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2025 Telekom AG
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
 # Contributing
 
 ## Code of conduct

diff --git a/Dockerfile b/Dockerfile
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 FROM alpine:3.21 as prep
 
 RUN apk add --no-cache ca-certificates

diff --git a/LICENSES/Apache-2.0.txt b/LICENSES/Apache-2.0.txt
@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2025 Maximilian Schubert, Deutsche Telekom IT GmbH
+   Copyright 2025 Deutsche Telekom IT GmbH
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/NOTICE b/NOTICE
@@ -1,4 +1,6 @@
-Copyright (c) 2024 Deutsche Telekom IT GmbH.
+// SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+//
+// SPDX-License-Identifier: Apache-2.0
 
 This project is licensed under Apache License, Version 2.0; 
 you may not use them except in compliance with the License. 

diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
 # Sparrow - Infrastructure Monitoring<!-- omit from toc -->
 
 <!-- markdownlint-disable MD033 -->

diff --git a/REUSE.toml b/REUSE.toml
@@ -0,0 +1,18 @@
+# SPDX-FileCopyrightText: 2024 Deutsche Telekom AG
+#
+# SPDX-License-Identifier: CC0-1.0    
+
+# See https://reuse.software/spec-3.2/#reusetoml for specification
+version = 1
+
+[[annotations]]
+path = [
+    ".idea/**",
+    ".vscode/**",
+    "**moq.go",
+    "docs/**",
+    "go.sum"
+]
+precedence = "aggregate"
+SPDX-FileCopyrightText = "Deutsche Telekom IT GmbH"
+SPDX-License-Identifier = "Apache-2.0"
diff --git a/chart/Chart.yaml b/chart/Chart.yaml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 apiVersion: v2
 name: sparrow
 description: A Helm chart to install Sparrow

diff --git a/chart/REUSE.toml b/chart/REUSE.toml
@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: 2024 Deutsche Telekom AG
+#
+# SPDX-License-Identifier: CC0-1.0    
+
+# See https://reuse.software/spec-3.2/#reusetoml for specification
+version = 1
+
+[[annotations]]
+path = ["templates/**", "README.md"]
+precedence = "aggregate"
+SPDX-FileCopyrightText = "Deutsche Telekom IT GmbH"
+SPDX-License-Identifier = "Apache-2.0"
diff --git a/chart/values.yaml b/chart/values.yaml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # Default values for sparrow.
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.

diff --git a/cmd/flag.go b/cmd/flag.go
@@ -1,20 +1,6 @@
-// sparrow
-// (C) 2024, Deutsche Telekom IT GmbH
+// SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
 //
-// Deutsche Telekom IT GmbH and all other contributors /
-// copyright owners license this file to you 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.
+// SPDX-License-Identifier: Apache-2.0
 
 package cmd
 

diff --git a/cmd/root.go b/cmd/root.go
@@ -1,20 +1,6 @@
-// sparrow
-// (C) 2023, Deutsche Telekom IT GmbH
+// SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
 //
-// Deutsche Telekom IT GmbH and all other contributors /
-// copyright owners license this file to you 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.
+// SPDX-License-Identifier: Apache-2.0
 
 package cmd
 

diff --git a/cmd/run.go b/cmd/run.go
@@ -1,20 +1,6 @@
-// sparrow
-// (C) 2023, Deutsche Telekom IT GmbH
+// SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
 //
-// Deutsche Telekom IT GmbH and all other contributors /
-// copyright owners license this file to you 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.
+// SPDX-License-Identifier: Apache-2.0
 
 package cmd
 

diff --git a/docs/sparrow.md b/docs/sparrow.md
@@ -18,3 +18,4 @@ The check results are exposed via an API.
 
 * [sparrow run](sparrow_run.md)	 - Run sparrow
 
+###### Auto generated by spf13/cobra on 13-Jan-2025
diff --git a/docs/sparrow_completion.md b/docs/sparrow_completion.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
 ## sparrow completion
 
 Generate the autocompletion script for the specified shell

diff --git a/docs/sparrow_completion_bash.md b/docs/sparrow_completion_bash.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
 ## sparrow completion bash
 
 Generate the autocompletion script for bash

diff --git a/docs/sparrow_completion_fish.md b/docs/sparrow_completion_fish.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
 ## sparrow completion fish
 
 Generate the autocompletion script for fish

diff --git a/docs/sparrow_completion_powershell.md b/docs/sparrow_completion_powershell.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
 ## sparrow completion powershell
 
 Generate the autocompletion script for powershell

diff --git a/docs/sparrow_completion_zsh.md b/docs/sparrow_completion_zsh.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
 ## sparrow completion zsh
 
 Generate the autocompletion script for zsh

diff --git a/docs/sparrow_run.md b/docs/sparrow_run.md
@@ -36,3 +36,4 @@ sparrow run [flags]
 
 * [sparrow](sparrow.md)	 - Sparrow, the infrastructure monitoring agent
 
+###### Auto generated by spf13/cobra on 13-Jan-2025
diff --git a/e2e/traceroute/lab.conf.license b/e2e/traceroute/lab.conf.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+
+SPDX-License-Identifier: Apache-2.0
diff --git a/e2e/traceroute/pc1.startup.license b/e2e/traceroute/pc1.startup.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+
+SPDX-License-Identifier: Apache-2.0
diff --git a/e2e/traceroute/pc2.startup.license b/e2e/traceroute/pc2.startup.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+
+SPDX-License-Identifier: Apache-2.0
diff --git a/e2e/traceroute/r1.startup.license b/e2e/traceroute/r1.startup.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+
+SPDX-License-Identifier: Apache-2.0
diff --git a/e2e/traceroute/r2.startup.license b/e2e/traceroute/r2.startup.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+
+SPDX-License-Identifier: Apache-2.0
diff --git a/e2e/traceroute/shared/config.yaml b/e2e/traceroute/shared/config.yaml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # DNS sparrow is exposed on
 name: sparrow.caas-t21.telekom.de
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,3 +18,4 @@ The check results are exposed via an API.

		* [sparrow run](sparrow_run.md) - Run sparrow

		###### Auto generated by spf13/cobra on 13-Jan-2025
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,3 +36,4 @@ sparrow run [flags]

		* [sparrow](sparrow.md) - Sparrow, the infrastructure monitoring agent

		###### Auto generated by spf13/cobra on 13-Jan-2025
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		SPDX-FileCopyrightText: 2025 Deutsche Telekom IT GmbH

		SPDX-License-Identifier: Apache-2.0