This repository has been archived by the owner on Oct 16, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Make project REUSE compliant - Add Makefile with add/check license - Add gitignore to project
- Loading branch information
Showing
11 changed files
with
108 additions
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Binaries for programs and plugins | ||
| *.exe | ||
| *.exe~ | ||
| *.dll | ||
| *.so | ||
| *.dylib | ||
| bin | ||
|
|
||
| # Test binary, build with `go test -c` | ||
| *.test | ||
|
|
||
| # Output of the go coverage tool, specifically when used with LiteIDE | ||
| *.out | ||
|
|
||
| vendor/ | ||
|
|
||
| # editor and IDE paraphernalia | ||
| .idea | ||
| *.swp | ||
| *.swo | ||
| *~ | ||
| .vscode/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,32 @@ | ||
| Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ | ||
| Upstream-Name: <YOUR-REPO-NAME> | ||
| Upstream-Contact: <YOUR-CONTACT (MAIL ADDRESS ETC.)> | ||
| Source: <https://github.com/onmetal/YOUR-REPO-NAME> | ||
| Disclaimer: The code in this project may include calls to APIs ("API Calls") of | ||
| SAP or third-party products or services developed outside of this project | ||
| ("External Products"). | ||
| "APIs" means application programming interfaces, as well as their respective | ||
| specifications and implementing code that allows software to communicate with | ||
| other software. | ||
| API Calls to External Products are not licensed under the open source license | ||
| that governs this project. The use of such API Calls and related External | ||
| Products are subject to applicable additional agreements with the relevant | ||
| provider of the External Products. In no event shall the open source license | ||
| that governs this project grant any rights in or to any External Products,or | ||
| alter, expand or supersede any terms of the applicable additional agreements. | ||
| If you have a valid license agreement with SAP for the use of a particular SAP | ||
| External Product, then you may make use of any API Calls included in this | ||
| project's code for that SAP External Product, subject to the terms of such | ||
| license agreement. If you do not have a valid license agreement for the use of | ||
| a particular SAP External Product, then you may only make use of any API Calls | ||
| in this project for that SAP External Product for your internal, non-productive | ||
| and non-commercial test and evaluation of such API Calls. Nothing herein grants | ||
| you any rights to use or access any SAP External Product, or provide any third | ||
| parties the right to use of access any SAP External Product, through API Calls. | ||
| Upstream-Name: prometheus-dpdk-exporter | ||
| Upstream-Contact: IronCore authors <[email protected]> | ||
| Source: https://github.com/ironcore-dev/prometheus-dpdk-exporter | ||
|
|
||
| Files: <YOUR-FILE-OR-FOLDER-LIST> | ||
| Copyright: <YEARS-RELEVANT-FOR-YOUR-PROJECT> SAP SE or an SAP affiliate company and <YOUR-PROJECT-NAME> contributors | ||
| # -------------------------------------------------- | ||
| # source code | ||
|
|
||
| Files: | ||
| .github/* | ||
| .gitignore | ||
| .golangci.yaml | ||
| CODEOWNERS | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| Makefile | ||
| go.mod | ||
| go.sum | ||
| hack/* | ||
| Copyright: 2023 SAP SE or an SAP affiliate company and IronCore contributors | ||
| License: Apache-2.0 | ||
|
|
||
| Files: <THIRD-PARTY-FILE-OR-FOLDER-LIST> | ||
| Copyright: <COPYRIGHT-OF-THIRD-PARTY-CODE> | ||
| License: <LICENSE-OF-THIRD-PARTY-CODE> | ||
| # -------------------------------------------------- | ||
| # documentation | ||
|
|
||
| Files: | ||
| README.md | ||
| Copyright: 2023 SAP SE or an SAP affiliate company and IronCore contributors | ||
| License: Apache-2.0 | ||
|
|
||
| Files: <ANOTHER-THIRD-PARTY-FILE-OR-FOLDER-LIST> | ||
| Copyright: <COPYRIGHT-OF-ANOTHER-THIRD-PARTY-CODE> | ||
| License: <LICENSE-OF-ANOTHER- THIRD-PARTY-CODE> | ||
| # -------------------------------------------------- | ||
| # source dependencies |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| ##@ General | ||
|
|
||
| # The help target prints out all targets with their descriptions organized | ||
| # beneath their categories. The categories are represented by '##@' and the | ||
| # target descriptions by '##'. The awk commands is responsible for reading the | ||
| # entire set of makefiles included in this invocation, looking for lines of the | ||
| # file as xyz: ## something, and then pretty-format the target and help. Then, | ||
| # if there's a line with ##@ something, that gets pretty-printed as a category. | ||
| # More info on the usage of ANSI control characters for terminal formatting: | ||
| # https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters | ||
| # More info on the awk command: | ||
| # http://linuxcommand.org/lc3_adv_awk.php | ||
|
|
||
| .PHONY: help | ||
| help: ## Display this help. | ||
| @awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) | ||
|
|
||
| .PHONY: check | ||
| check: check-license # Check project | ||
|
|
||
| .PHONY: add-license | ||
| add-license: addlicense ## Add license headers to all go files. | ||
| find . -name '*.go' -exec $(ADDLICENSE) -f hack/license-header.txt {} + | ||
|
|
||
| .PHONY: check-license | ||
| check-license: addlicense ## Check that every file has a license header present. | ||
| find . -name '*.go' -exec $(ADDLICENSE) -check -c 'IronCore authors' {} + | ||
|
|
||
| ##@ Tools | ||
|
|
||
| ## Location to install dependencies to | ||
| LOCALBIN ?= $(shell pwd)/bin | ||
| $(LOCALBIN): | ||
| mkdir -p $(LOCALBIN) | ||
|
|
||
| ## Tool Binaries | ||
| ADDLICENSE ?= $(LOCALBIN)/addlicense | ||
|
|
||
| ## Tool Versions | ||
| ADDLICENSE_VERSION ?= v1.1.1 | ||
|
|
||
| .PHONY: addlicense | ||
| addlicense: $(ADDLICENSE) ## Download addlicense locally if necessary. | ||
| $(ADDLICENSE): $(LOCALBIN) | ||
| test -s $(LOCALBIN)/addlicense || GOBIN=$(LOCALBIN) go install github.com/google/addlicense@$(ADDLICENSE_VERSION) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,2 @@ | ||
| /* | ||
| * Copyright (c) 2021 by the IronCore authors. | ||
| * | ||
| * 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. | ||
| */ | ||
| // SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and IronCore contributors | ||
| // SPDX-License-Identifier: Apache-2.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and IronCore contributors | ||
| SPDX-License-Identifier: Apache-2.0 |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters