diff --git a/.gitignore b/.gitignore index ea4f9c4ba88d5ebf96e2a7e90057bb6f09b68ab8..cfee8f658bdfe1901a246e2543ee456ee7432470 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +Makefile.example # Created by https://www.toptal.com/developers/gitignore/api/intellij+iml,phpunit,git,vim,visualstudiocode,phpstorm,go,intellij+all,netbeans,dbeaver,node,yarn # Edit at https://www.toptal.com/developers/gitignore?templates=intellij+iml,phpunit,git,vim,visualstudiocode,phpstorm,go,intellij+all,netbeans,dbeaver,node,yarn diff --git a/Makefile b/Makefile index 7ce8147cd30dd43d56d58f4755177b31bd988276..8b9cf8661a608f865f47eb73483c8359002e6fc9 100644 --- a/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ ############################################################################################# ############################################################################################# -COMPONENT_NAME := Monster +COMPONENT_NAME := Conan ############################################################################################# ############################################################################################# @@ -21,12 +21,14 @@ THIS_MAKEFILE_PATH:=$(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST)) PROJECT_ROOT:=$(shell cd $(dir $(THIS_MAKEFILE_PATH));pwd)/ THIS_MAKEFILE:=$(PROJECT_ROOT)$(THIS_MAKEFILE_PATH) - +# include project.mk only if it exists -include $(PROJECT_ROOT)project.mk -## Define the location of Makefiles +# Define the location of Makefiles MAKEFILE_IMPORT_PATH?=$(PROJECT_ROOT)makefiles/ + +# include project.mk only if it exists -include $(MAKEFILE_IMPORT_PATH)project.mk ############################################################################################# @@ -41,30 +43,41 @@ include $(MAKEFILE_IMPORT_PATH)directories-standard.mk #include $(MAKEFILE_IMPORT_PATH)jsdoc.mk include $(MAKEFILE_IMPORT_PATH)output.mk include $(MAKEFILE_IMPORT_PATH)placeholder.mk -include $(MAKEFILE_IMPORT_PATH)s3.mk +#include $(MAKEFILE_IMPORT_PATH)s3.mk +#include $(MAKEFILE_IMPORT_PATH)licenses.mk #include $(MAKEFILE_IMPORT_PATH)license-agpl3.mk +#include $(MAKEFILE_IMPORT_PATH)license-unlicensed.mk +#include $(MAKEFILE_IMPORT_PATH)license-all-rights-reserved.mk #include $(MAKEFILE_IMPORT_PATH)jsdoc-json.mk include $(MAKEFILE_IMPORT_PATH)go.mk +include $(MAKEFILE_IMPORT_PATH)changelog.mk +include $(MAKEFILE_IMPORT_PATH)docman.mk +#include $(MAKEFILE_IMPORT_PATH)reqman.mk +include $(MAKEFILE_IMPORT_PATH)git.mk include $(MAKEFILE_IMPORT_PATH)gitignore.mk include $(MAKEFILE_IMPORT_PATH)color.mk include $(MAKEFILE_IMPORT_PATH)version.mk +#include $(MAKEFILE_IMPORT_PATH)docker.mk #include $(MAKEFILE_IMPORT_PATH)node.mk include $(MAKEFILE_IMPORT_PATH)terminal.mk -include $(MAKEFILE_IMPORT_PATH)target-go-fetch-licenses.mk -include $(MAKEFILE_IMPORT_PATH)target-deploy-tool.mk +#include $(MAKEFILE_IMPORT_PATH)target-go-fetch-licenses.mk +#include $(MAKEFILE_IMPORT_PATH)target-add-licenses.mk +#include $(MAKEFILE_IMPORT_PATH)target-deploy-tool.mk #include $(MAKEFILE_IMPORT_PATH)target-jsdoc-build.mk #include $(MAKEFILE_IMPORT_PATH)target-jekyll.mk #include $(MAKEFILE_IMPORT_PATH)target-minerva.mk #include $(MAKEFILE_IMPORT_PATH)target-docman.mk #include $(MAKEFILE_IMPORT_PATH)target-node-build.mk #include $(MAKEFILE_IMPORT_PATH)target-caddy.mk -include $(MAKEFILE_IMPORT_PATH)target-conan.mk +#include $(MAKEFILE_IMPORT_PATH)target-conan.mk include $(MAKEFILE_IMPORT_PATH)target-update-makefiles.mk include $(MAKEFILE_IMPORT_PATH)target-help.mk include $(MAKEFILE_IMPORT_PATH)target-go-build.mk #include $(MAKEFILE_IMPORT_PATH)target-node-test.mk #include $(MAKEFILE_IMPORT_PATH)target-npm-publish.mk include $(MAKEFILE_IMPORT_PATH)target-git.mk +include $(MAKEFILE_IMPORT_PATH)target-init-standard.mk +include $(MAKEFILE_IMPORT_PATH)target-version.mk include $(MAKEFILE_IMPORT_PATH)target-variable.mk include $(MAKEFILE_IMPORT_PATH)terminal-check.mk diff --git a/Makefile.example b/Makefile.example deleted file mode 100644 index ffbe88952ded52768d8e13635f0787be61926057..0000000000000000000000000000000000000000 --- a/Makefile.example +++ /dev/null @@ -1,73 +0,0 @@ -############################################################################################# -############################################################################################# -## -## PROJECT-DEFINITIONS -## -############################################################################################# -############################################################################################# - -COMPONENT_NAME := Monster - -############################################################################################# -############################################################################################# -## -## MORE GENERAL BLOCK WITH STANDARD DEFINITIONS -## -############################################################################################# -############################################################################################# - -# get Makefile directory name: http://stackoverflow.com/a/5982798/376773 -THIS_MAKEFILE_PATH:=$(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST)) -PROJECT_ROOT:=$(shell cd $(dir $(THIS_MAKEFILE_PATH));pwd)/ -THIS_MAKEFILE:=$(PROJECT_ROOT)$(THIS_MAKEFILE_PATH) - - --include $(PROJECT_ROOT)project.mk - - -## Define the location of Makefiles -MAKEFILE_IMPORT_PATH?=$(PROJECT_ROOT)makefiles/ --include $(MAKEFILE_IMPORT_PATH)project.mk - -############################################################################################# -############################################################################################# -## -## INCLUSION OF VARIOUS STANDARD RULES -## -############################################################################################# -############################################################################################# - -include $(MAKEFILE_IMPORT_PATH)directories-standard.mk -#include $(MAKEFILE_IMPORT_PATH)jsdoc.mk -include $(MAKEFILE_IMPORT_PATH)output.mk -include $(MAKEFILE_IMPORT_PATH)placeholder.mk -#include $(MAKEFILE_IMPORT_PATH)s3.mk -#include $(MAKEFILE_IMPORT_PATH)license-agpl3.mk -#include $(MAKEFILE_IMPORT_PATH)jsdoc-json.mk -#include $(MAKEFILE_IMPORT_PATH)go.mk -include $(MAKEFILE_IMPORT_PATH)gitignore.mk -include $(MAKEFILE_IMPORT_PATH)color.mk -include $(MAKEFILE_IMPORT_PATH)version.mk -#include $(MAKEFILE_IMPORT_PATH)node.mk -include $(MAKEFILE_IMPORT_PATH)terminal.mk -#include $(MAKEFILE_IMPORT_PATH)target-go-fetch-licenses.mk -#include $(MAKEFILE_IMPORT_PATH)target-deploy-tool.mk -#include $(MAKEFILE_IMPORT_PATH)target-jsdoc-build.mk -#include $(MAKEFILE_IMPORT_PATH)target-jekyll.mk -#include $(MAKEFILE_IMPORT_PATH)target-minerva.mk -#include $(MAKEFILE_IMPORT_PATH)target-docman.mk -#include $(MAKEFILE_IMPORT_PATH)target-node-build.mk -#include $(MAKEFILE_IMPORT_PATH)target-caddy.mk -#include $(MAKEFILE_IMPORT_PATH)target-conan.mk -include $(MAKEFILE_IMPORT_PATH)target-update-makefiles.mk -include $(MAKEFILE_IMPORT_PATH)target-help.mk -#include $(MAKEFILE_IMPORT_PATH)target-go-build.mk -#include $(MAKEFILE_IMPORT_PATH)target-node-test.mk -#include $(MAKEFILE_IMPORT_PATH)target-npm-publish.mk -include $(MAKEFILE_IMPORT_PATH)target-git.mk -include $(MAKEFILE_IMPORT_PATH)target-init-standard.mk -include $(MAKEFILE_IMPORT_PATH)target-variable.mk -include $(MAKEFILE_IMPORT_PATH)terminal-check.mk - - -############################################################################################# diff --git a/development/makefile/changelog.mk b/development/makefile/changelog.mk new file mode 100644 index 0000000000000000000000000000000000000000..02f1563e9a4f851493fd64abe232a2c64ce8dd51 --- /dev/null +++ b/development/makefile/changelog.mk @@ -0,0 +1,22 @@ +############################################################################################# +############################################################################################# +## +## CHANGELOG +## +############################################################################################# +############################################################################################# + + +GIT_CHGLOG_BIN := $(shell command -v git-chglog 2> /dev/null) + +ifeq ($(GO),) + $(error $(ERRORMARKER) GO is not defined) +endif + +ifeq ($(GIT_CHGLOG_BIN),) + $(shell $(GO) install github.com/git-chglog/git-chglog/cmd/git-chglog@latest) +endif + +## location of CHANGELOG.md file +CHANGELOG_FILE ?= $(PROJECT_ROOT)CHANGELOG.md +EXECUTABLES = $(EXECUTABLES:-) $(GIT_CHGLOG_BIN) \ No newline at end of file diff --git a/development/makefile/docker.mk b/development/makefile/docker.mk new file mode 100644 index 0000000000000000000000000000000000000000..4bc7f6c984beb519d1fbc767d0480920bc72f49a --- /dev/null +++ b/development/makefile/docker.mk @@ -0,0 +1,11 @@ +############################################################################################# +############################################################################################# +## +## DOCKER +## +############################################################################################# +############################################################################################# + +DOCKER ?= docker +EXECUTABLES = $(EXECUTABLES:-) $(DOCKER); + diff --git a/development/makefile/docman.mk b/development/makefile/docman.mk new file mode 100644 index 0000000000000000000000000000000000000000..cc61cff5ba99d12818613002164e4aaf3353b7ac --- /dev/null +++ b/development/makefile/docman.mk @@ -0,0 +1,10 @@ +############################################################################################# +############################################################################################# +## +## DOCMAN +## +############################################################################################# +############################################################################################# + + +DOCMAN_BIN ?= $(VENDOR_PATH)docman diff --git a/development/makefile/git.mk b/development/makefile/git.mk new file mode 100644 index 0000000000000000000000000000000000000000..5521077229d9fa29ad53cb945b872db978996347 --- /dev/null +++ b/development/makefile/git.mk @@ -0,0 +1,12 @@ +############################################################################################# +############################################################################################# +## +## GIT +## +############################################################################################# +############################################################################################# + +GIT ?= git +UUIDGEN ?= uuidgen + +EXECUTABLES = $(EXECUTABLES:-) $(UUIDGEN) $(GIT) \ No newline at end of file diff --git a/development/makefile/gitignore.mk b/development/makefile/gitignore.mk index 4131f64a25d954c6a461a624798e67c174d8c701..283b8f721442de93d2f8e05f8ebf12d6348e83a9 100644 --- a/development/makefile/gitignore.mk +++ b/development/makefile/gitignore.mk @@ -7,6 +7,9 @@ ############################################################################################# define GITIGNOREDS + +Makefile.example + # Created by https://www.toptal.com/developers/gitignore/api/intellij+iml,phpunit,git,vim,visualstudiocode,phpstorm,go,intellij+all,netbeans,dbeaver,node,yarn # Edit at https://www.toptal.com/developers/gitignore?templates=intellij+iml,phpunit,git,vim,visualstudiocode,phpstorm,go,intellij+all,netbeans,dbeaver,node,yarn diff --git a/development/makefile/go.mk b/development/makefile/go.mk index 29955369f69ad15bb22c2cd1c77bdd127977aaf9..00ff9478e3e0d69e4370abb88dcaca5f88185437 100644 --- a/development/makefile/go.mk +++ b/development/makefile/go.mk @@ -10,3 +10,7 @@ GO := go EXECUTABLES = $(EXECUTABLES:-) $(GO); + +ifeq ($(shell command -v $(GO) 2> /dev/null),) + $(error "go is not installed. Please install go <https://go.dev/doc/install>") +endif diff --git a/development/makefile/license-agpl3.mk b/development/makefile/license-agpl3.mk index ebb06a7123fe3efbd7f1f8d5bc70608a76c84674..6c3e73e274536102d475d8bbf2a035df39a92453 100644 --- a/development/makefile/license-agpl3.mk +++ b/development/makefile/license-agpl3.mk @@ -1,7 +1,7 @@ ############################################################################################# ############################################################################################# ## -## COLORS +## AGPL 3.0 LICENSE ## ############################################################################################# ############################################################################################# @@ -9,5 +9,11 @@ ## License used in the project LICENSE_TEXT ?= AGPL 3.0 +## The spdx license identifier +SPDX_LICENSE_ID ?= AGPL-3.0 + ## Copyright holder of the project -COPYRIGHT_TEXT ?= © schukai GmbH, Released under the $(LICENSE_TEXT) License. \ No newline at end of file +COPYRIGHT_TEXT ?= © schukai GmbH, Released under the $(LICENSE_TEXT) License. + +## The owner of the project +COPYRIGHT_OWNER ?= schukai GmbH \ No newline at end of file diff --git a/development/makefile/license-all-rights-reserved.mk b/development/makefile/license-all-rights-reserved.mk new file mode 100644 index 0000000000000000000000000000000000000000..c5f61f224a51b8461ecd0a42a887989de30a5aaa --- /dev/null +++ b/development/makefile/license-all-rights-reserved.mk @@ -0,0 +1,19 @@ +############################################################################################# +############################################################################################# +## +## AGPL 3.0 LICENSE +## +############################################################################################# +############################################################################################# + +## License used in the project +LICENSE_TEXT ?= All rights reserved + +## The spdx license identifier +SPDX_LICENSE_ID ?= + +## Copyright holder of the project +COPYRIGHT_TEXT ?= © schukai GmbH, $(LICENSE_TEXT). + +## The owner of the project +COPYRIGHT_OWNER ?= schukai GmbH \ No newline at end of file diff --git a/development/makefile/license-unlicensed.mk b/development/makefile/license-unlicensed.mk new file mode 100644 index 0000000000000000000000000000000000000000..42443e1fcdcfc8d00fee53b7ae1206a24548ba47 --- /dev/null +++ b/development/makefile/license-unlicensed.mk @@ -0,0 +1,19 @@ +############################################################################################# +############################################################################################# +## +## UNLICENSED +## +############################################################################################# +############################################################################################# + +## License used in the project +LICENSE_TEXT ?= UNLICENSED + +## The spdx license identifier +SPDX_LICENSE_ID ?= + +## Copyright holder of the project +COPYRIGHT_TEXT ?= © schukai GmbH, $(LICENSE_TEXT). + +## The owner of the project +COPYRIGHT_OWNER ?= schukai GmbH \ No newline at end of file diff --git a/development/makefile/licenses.mk b/development/makefile/licenses.mk new file mode 100644 index 0000000000000000000000000000000000000000..3de604d2e760527cfa488909352aacb9d4e93027 --- /dev/null +++ b/development/makefile/licenses.mk @@ -0,0 +1,19 @@ +############################################################################################# +############################################################################################# +## +## LICENSE +## +############################################################################################# +############################################################################################# + +## Files wich should be checked for license headers +LICENSE_FILE_PATTERN ?= ./*(.go|js|php) + +# https://spdx.github.io/spdx-spec/v2.3/SPDX-license-list/ +ADDLICENSE_BIN ?= addlicense +ifeq ($(shell command -v $(ADDLICENSE_BIN) 2> /dev/null),) + $(shell $(GO) install github.com/google/addlicense@latest) + EXECUTABLES = $(EXECUTABLES:-) $(ADDLICENSE_BIN); +endif + +EXECUTABLES = $(EXECUTABLES:-) $(ADDLICENSE_BIN) \ No newline at end of file diff --git a/development/makefile/node.mk b/development/makefile/node.mk index 346fe3bec228435cb40e41c83f6b95ac36bc75ce..dc9001f840f222adb45030db5ca6a90578415de1 100644 --- a/development/makefile/node.mk +++ b/development/makefile/node.mk @@ -11,11 +11,12 @@ NODEJS ?= node NODE ?= node NPM ?= pnpm -EXECUTABLES = $(EXECUTABLES:-) $(PNPM); +EXECUTABLES = $(EXECUTABLES:-) $(NPM); NODE_PACKAGES := $(shell find $(PROJECT_ROOT) -type f -name 'package.json' -not -path '*/node_modules/*') NODE_MODULES := $(shell find $(PROJECT_ROOT) -type d -name 'node_modules' -prune) -NODE_MODULES_MODIFIED := $(shell find $(PROJECT_ROOT) -type d -name 'node_modules' -prune -exec echo {}/.modified \; ) + +NODE_MODULES_MODIFIED := $(shell find . -type f -name 'package.json' -not -path '*/node_modules/*' -exec sh -c 'F=$$(dirname {}); echo $${F}/node_modules/.modified' \;) $(NODE_MODULES_MODIFIED): $(NODE_PACKAGES) $(ECHOMARKER) "Updating node modules..." diff --git a/development/makefile/reqman.mk b/development/makefile/reqman.mk new file mode 100644 index 0000000000000000000000000000000000000000..64f4e1ab165dd831659cd207b5c8935f52d31f71 --- /dev/null +++ b/development/makefile/reqman.mk @@ -0,0 +1,10 @@ +############################################################################################# +############################################################################################# +## +## REQMAN +## +############################################################################################# +############################################################################################# + + +REQMAN_BIN ?= $(VENDOR_PATH)reqman diff --git a/development/makefile/target-add-licenses.mk b/development/makefile/target-add-licenses.mk new file mode 100644 index 0000000000000000000000000000000000000000..05de8221faa39c25ad59221825ede95c0846fdc9 --- /dev/null +++ b/development/makefile/target-add-licenses.mk @@ -0,0 +1,24 @@ +############################################################################################# +############################################################################################# +## +## ADD SPDX LICENSES +## +## For commercial projects, it is not necessary to add the SPDX license identifier. +## The license header in each file is only for open-source projects, for example under +## the AGPL 3.0 license. +## +############################################################################################# +############################################################################################# + +ifeq ($(ADDLICENSE_BIN),) + $(error "addlicense is not installed. Please check your makefile and include the licenses.mk") +endif + +.PHONY: add-licenses +## Add license headers to all go files +add-licenses: + $(ECHOMARKER) "Add license headers to all go files" +ifndef SPDX_LICENSE_ID + $(error "SPDX_LICENSE_ID is not defined. Please check your makefile and include the licenses.mk") +endif + $(QUIET) $(ADDLICENSE_BIN) -c "$(COPYRIGHT_OWNER)" -s -l "$(SPDX_LICENSE_ID)" $(LICENSE_FILE_PATTERN) \ No newline at end of file diff --git a/development/makefile/target-conan.mk b/development/makefile/target-conan.mk index 3f50af7c3ebe69bb62418dd9725749bdd54d3dc5..06f3182b47b763334c8c4a0313fbfdd7d6fdc101 100644 --- a/development/makefile/target-conan.mk +++ b/development/makefile/target-conan.mk @@ -17,5 +17,5 @@ $(CONAN_BIN): .PHONY: run-conan ## run conan webserver run-conan: $(CONAN_BIN) - $(QUIET) $(CONAN_BIN) server serve --config $(CONAN_CONFIG) + $(QUIET) $(CONAN_BIN) server serve -config $(CONAN_CONFIG) diff --git a/development/makefile/target-docman.mk b/development/makefile/target-docman.mk index e5c836ed8f11e2c3d627aa7761503781e772f746..050374042edb1b317f88df55b763df189bf0d25c 100644 --- a/development/makefile/target-docman.mk +++ b/development/makefile/target-docman.mk @@ -7,13 +7,20 @@ ############################################################################################# ############################################################################################# +ifeq ($(DOCMAN_BIN),) + $(error "$(DOCMAN_BIN) is not installed. Please check your makefile and include the docman.mk") +endif +$(DOCMAN_BIN): + $(QUIET) $(MKDIR) -p $(VENDOR_PATH) + $(QUIET) $(WGET) -O $(DOCMAN_BIN) http://download.schukai.com/tools/docman/docman-$(shell uname -s | tr [:upper:] [:lower:])-$(shell echo `uname -m | sed s/aarch64/arm64/ | sed s/x86_64/amd64/`) + $(QUIET) $(CHMOD) u+x $(DOCMAN_BIN) -$(PROJECT_ROOT)deployment/build/manual.html: ~/.local/bin/docman - docman document html --config $(PROJECT_ROOT)documentation/config.yaml +$(PROJECT_ROOT)deployment/build/manual.html: $(DOCMAN_BIN) + $(DOCMAN_BIN) document html --config $(PROJECT_ROOT)documentation/config.yaml -$(PROJECT_ROOT)deployment/build/manual.pdf: ~/.local/bin/docman - docman document pdf --config $(PROJECT_ROOT)documentation/config.yaml +$(PROJECT_ROOT)deployment/build/manual.pdf: $(DOCMAN_BIN) + $(DOCMAN_BIN) document pdf --config $(PROJECT_ROOT)documentation/config.yaml .PHONY: build-doc-pdf ## creating the documentation in pdf format @@ -29,11 +36,3 @@ build-doc-html: $(PROJECT_ROOT)deployment/build/manual.html build-doc: build-doc-pdf build-doc-html -~/.local/bin/docman: - wget -O ~/.local/bin/docman https://download.schukai.com/tools/docman/docman-linux-amd64 - chmod u+x ~/.local/bin/docman - - -.PHONY: install-docman -install-docman: ~/.local/bin/docman - diff --git a/development/makefile/target-git.mk b/development/makefile/target-git.mk index 7453d893b2488fd027e1c4a05095f5d613ff0279..d4ac20d62ba4489b6ab175b615c2324b5674272b 100644 --- a/development/makefile/target-git.mk +++ b/development/makefile/target-git.mk @@ -6,7 +6,9 @@ ############################################################################################# ############################################################################################# -EXECUTABLES = $(EXECUTABLES:-) uuidgen +ifeq ($(GIT),) + $(error $(ERRORMARKER) Git is not defined, check your Makefile if git.mk is included) +endif ## Current Branch-GIT_TAG GIT_TAG := - @@ -17,7 +19,6 @@ GIT_MESSAGE := current status .PHONY: git-branch ## create new branch (use GIT_TAG-Variable) git-branch: - $(QUIET) export BRANCH="b$(GIT_TAG)/$(shell uuidgen --random)" ; \ $(QUIET) $(GIT) checkout -b $${BRANCH} && \ RESULT=$$($(GIT) push origin $$BRANCH 2>&1) && \ @@ -45,3 +46,13 @@ git-push: git-branch git-push-to-server ## git create version tag git-tag: $(QUIET) $(GIT) tag -a "$(COMPONENT_VERSION)" -m "release $(COMPONENT_VERSION)" + +.PHONY: git-prune-remote +## removes your local remote tracking branches where the branch no longer exists on the remote +git-prune-remote: + $(QUIET) $(GIT) remote prune origin + +.PHONY: git-prune-local +## deletes local merged branches except the master branch +git-prune-local: + $(QUIET) $(GIT) branch --merged master | grep -v '^[ *]*master$$' | xargs git branch -d \ No newline at end of file diff --git a/development/makefile/target-go-build.mk b/development/makefile/target-go-build.mk index ec473abe64a85259e232f24ffebac3102f42e7c4..23139cdceb1f8f01d2a8d52d9308c38a751989e4 100644 --- a/development/makefile/target-go-build.mk +++ b/development/makefile/target-go-build.mk @@ -6,6 +6,10 @@ ############################################################################################# ############################################################################################# +ifeq ($(GO),) + $(error $(ERRORMARKER) Go is not defined, check your Makefile if go.mk is included) +endif + GO_RELEASE_PACKAGE_NAME ?= main .PHONY: compile diff --git a/development/makefile/target-go-fetch-licenses.mk b/development/makefile/target-go-fetch-licenses.mk index 4bd753cb137214c430e7bf306ff66a031a447df4..242f3d346950f04bdc2ae8bb3d465b0ba9b7ebda 100644 --- a/development/makefile/target-go-fetch-licenses.mk +++ b/development/makefile/target-go-fetch-licenses.mk @@ -6,12 +6,16 @@ ############################################################################################# ############################################################################################# +ifeq ($(GO),) + $(error $(ERRORMARKER) Go is not defined, check your Makefile if go.mk is included) +endif + GO_MOD_FILE := $(SOURCE_PATH)go.mod ifeq ($(shell test -e $(GO_MOD_FILE) && echo -n yes),yes) - GO_CURRENT_MODULE := $(shell cat $(GO_MOD_FILE) | head -n1 | cut -d" " -f2) - # go install github.com/google/go-licenses@latest - EXECUTABLES = $(EXECUTABLES:-) go-licenses; + GO_CURRENT_MODULE := $(shell cat $(GO_MOD_FILE) | head -n1 | cut -d" " -f2) + # go install github.com/google/go-licenses@latest + EXECUTABLES = $(EXECUTABLES:-) go-licenses; endif .PHONY: go-fetch-licenses @@ -21,6 +25,6 @@ ifeq ($(GO_CURRENT_MODULE),) $(QUIET) $(ECHOERRORMARKER) "no go.mod file found, skipping fetching licenses" else $(ECHOMARKER) "Fetch licenses" - $(QUIET) cd $(SOURCE_PATH); go-licenses save $(GO_CURRENT_MODULE) $(GO_LICENSES_IGNORE_PACKAGES) --force --save_path $(DOCUMENTATION_PATH)licenses/ ; cd - + $(QUIET) cd $(SOURCE_PATH); $(GO_LICENSES_BIN) save $(GO_CURRENT_MODULE) $(GO_LICENSES_IGNORE_PACKAGES) --force --save_path $(DOCUMENTATION_PATH)licenses/ ; cd - endif diff --git a/development/makefile/target-node-build.mk b/development/makefile/target-node-build.mk index 9dde98e8358b74a2330a2ea083256e46dec629a3..0ee3a09e799f8a6ec873a61f35e220031322a19a 100644 --- a/development/makefile/target-node-build.mk +++ b/development/makefile/target-node-build.mk @@ -20,7 +20,7 @@ node-build: $(NODE_MODULES_MODIFIED) $(NODE_PACKAGES) $(QUIET) for p in $(NODE_PACKAGES); do \ $(JQ) '.version = "$(PROJECT_VERSION)"' $${p} | $(SPONGE) $${p}; \ done ; \ - $(QUIET) $(NPM) --prefix $(NODE_ROOT_DIR) run build + $(NPM) --prefix $(NODE_ROOT_DIR) run build diff --git a/development/makefile/target-reqman.mk b/development/makefile/target-reqman.mk new file mode 100644 index 0000000000000000000000000000000000000000..37db2ecad810f1ef0137cfe3bb4bb22bd025148b --- /dev/null +++ b/development/makefile/target-reqman.mk @@ -0,0 +1,40 @@ +############################################################################################# +############################################################################################# +## +## REQMAN-TARGETS +## +############################################################################################# +############################################################################################# + + +# @TODO not working, check if this is a bug in this definition!!! + +ifeq ($(REQMAN_BIN),) + $(error "$(REQMAN_BIN) is not installed. Please check your makefile and include the reqman.mk") +endif + +$(REQMAN_BIN): + $(QUIET) $(MKDIR) -p $(VENDOR_PATH) + $(QUIET) $(WGET) -O $(REQMAN_BIN) http://download.schukai.com/tools/reqman/reqman-$(shell uname -s | tr [:upper:] [:lower:])-$(shell echo `uname -m | sed s/aarch64/arm64/ | sed s/x86_64/amd64/`) + $(QUIET) $(CHMOD) u+x $(REQMAN_BIN) + +$(PROJECT_ROOT)deployment/build/manual.html: $(DOCMAN_BIN) + $(REQMAN_BIN) print html --config $(PROJECT_ROOT)requirement/config.yaml + +$(PROJECT_ROOT)deployment/build/manual.pdf: $(DOCMAN_BIN) + $(REQMAN_BIN) print pdf --config $(PROJECT_ROOT)requirement/config.yaml + +.PHONY: build-req-pdf +## creating the requirement in pdf format +build-req-pdf: $(PROJECT_ROOT)deployment/build/requirement.pdf + +.PHONY: build-req-html +## creating the requirement in html format +build-req-html: $(PROJECT_ROOT)deployment/build/requirement.html + + +.PHONY: build-req +## creating the requirement in pdf and html format +build-req: build-req-pdf build-req-html + + diff --git a/development/makefile/target-update-makefiles.mk b/development/makefile/target-update-makefiles.mk index 5a1c40877e308f0ee6aee25ae7f50f6da8f24209..284df847df3b474d9d040de2a4fc424bbcff9b85 100644 --- a/development/makefile/target-update-makefiles.mk +++ b/development/makefile/target-update-makefiles.mk @@ -6,15 +6,24 @@ ############################################################################################# ############################################################################################# +ifeq ($(GIT),) + $(error $(ERRORMARKER) Git is not defined, check your Makefile if git.mk is included) +endif + # @see .PHONY https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html#Phony-Targets .PHONY: update-makefiles +ifeq ($(QUIET),) + _COPYVERBOSE = -v +endif + ## update standard makefiles update-makefiles: + $(ECHOMARKER) "update standard makefiles" $(QUIET) $(eval TEMPD := $(shell mktemp -d)) - $(QUIET) $(GIT) clone --depth=1 https://gitlab.schukai.com/schukai/utilities/makefile.git/ "$(TEMPD)" > /dev/null - $(QUIET) $(CP) -rv $(TEMPD)/makefiles/* $(MAKEFILE_IMPORT_PATH) - $(QUIET) $(CP) -rv $(TEMPD)/Makefile $(PROJECT_ROOT)Makefile.example + $(QUIET) $(GIT) clone --quiet --depth=1 https://gitlab.schukai.com/schukai/utilities/makefile.git/ "$(TEMPD)" + $(QUIET) $(CP) -r $(_COPYVERBOSE) $(TEMPD)/makefiles/* $(MAKEFILE_IMPORT_PATH) + $(QUIET) $(CP) -r $(_COPYVERBOSE) $(TEMPD)/Makefile $(PROJECT_ROOT)Makefile.example $(QUIET) $(RM) -rf $(TEMPD) diff --git a/development/makefile/target-variable.mk b/development/makefile/target-variable.mk index 93f99c07fcc8ab3a8e000e865d7ddca2f2843220..3ad8267a765d377db7fa2d8e4037cfa7a4c6d698 100644 --- a/development/makefile/target-variable.mk +++ b/development/makefile/target-variable.mk @@ -9,4 +9,5 @@ .PHONY: variables ## Print all variables variables: - @$(foreach v, $(.VARIABLES), $(if $(filter file,$(origin $(v))), $(info $(INFO)$(v)$(RESET)=$($(v))$(RESET)))) \ No newline at end of file + $(ECHOMARKER) "print all variables" + $(QUIET) $(foreach v, $(.VARIABLES), $(if $(filter file,$(origin $(v))), $(info $(INFO)$(v)$(RESET)=$($(v))$(RESET)))) \ No newline at end of file diff --git a/development/makefile/target-version.mk b/development/makefile/target-version.mk new file mode 100644 index 0000000000000000000000000000000000000000..63a3457fe6e194349fbefbaee3c14238c28f88b9 --- /dev/null +++ b/development/makefile/target-version.mk @@ -0,0 +1,71 @@ +############################################################################################# +############################################################################################# +## +## VARIABLES-TARGETS +## +############################################################################################# +############################################################################################# + +ifeq ($(VERSION_BIN),) + $(error "$(VERSION_BIN) is not installed. Please check your makefile and include the version.mk") +endif + +ifeq ($(GIT),) + $(error $(ERRORMARKER) Git is not defined, check your Makefile if git.mk is included) +endif + +ifeq ($(GIT_CHGLOG_BIN),) + $(error $(ERRORMARKER) Chglog is not defined, check your Makefile if changelog.mk is included) +endif + +$(VERSION_BIN): + $(QUIET) $(MKDIR) -p $(VENDOR_PATH) + $(QUIET) $(WGET) -O $(VERSION_BIN) http://download.schukai.com/tools/version/version-$(shell uname -s | tr [:upper:] [:lower:])-$(shell echo `uname -m | sed s/aarch64/arm64/ | sed s/x86_64/amd64/`) + $(QUIET) $(CHMOD) u+x $(VERSION_BIN) + + +.PHONY: next-patch-version +next-patch-version: check-clean-repo $(VERSION_BIN) + $(ECHOMARKER) "Creating next version" + $(QUIET) $(VERSION_BIN) patch --path $(RELEASE_FILE) --selector "version" + $(QUIET) $(GIT) add $(RELEASE_FILE) && $(GIT) commit -m "Bump version to $$(cat $(RELEASE_FILE) | jq -r .version)" + +.PHONY: next-minor-version +next-minor-version: check-clean-repo $(VERSION_BIN) + $(ECHOMARKER) "Creating next minor version" + $(QUIET) $(VERSION_BIN) minor --path $(RELEASE_FILE) --selector "version" + $(QUIET) $(GIT) add $(RELEASE_FILE) && $(GIT) commit -m "Bump version to $$( cat $(RELEASE_FILE) | jq -r .version)" + +.PHONY: next-major-version +next-major-version: check-clean-repo $(VERSION_BIN) + $(ECHOMARKER) "Creating next minor version" + $(QUIET) $(VERSION_BIN) major --path $(RELEASE_FILE) --selector "version" + $(QUIET) $(GIT) add $(RELEASE_FILE) && $(GIT) commit -m "Bump version to $$(cat $(RELEASE_FILE) | jq -r .version)" + +.PHONY: check-clean-repo +check-clean-repo: + $(QUIET) $(GIT) diff-index --quiet HEAD || (echo "There are uncommitted changes after running make. Please commit or stash them before running make."; exit 1) + +## tag repository with next patch version +tag-patch-version: next-patch-version + $(ECHOMARKER) "Tagging patch version" + $(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version)) + $(GIT_CHGLOG_BIN) --next-tag v$(PROJECT_VERSION) -o $(CHANGELOG_FILE) + $(QUIET) $(GIT) add $(CHANGELOG_FILE) && $(GIT) commit -m "Update changelog" + $(QUIET) $(GIT) tag -a v$(PROJECT_VERSION) -m "Version $(PROJECT_VERSION)" + +## tag repository with next minor version +tag-minor-version: next-minor-version + $(ECHOMARKER) "Tagging minor version" + $(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version)) + $(GIT_CHGLOG_BIN) --next-tag v$(PROJECT_VERSION) -o $(CHANGELOG_FILE) + $(QUIET) $(GIT) add $(CHANGELOG_FILE) && $(GIT) commit -m "Update changelog" + $(QUIET) $(GIT) tag -a v$(PROJECT_VERSION) -m "Version $(PROJECT_VERSION)" + +## tag repository with next major version +tag-major-version: next-major-version + $(ECHOMARKER) "Tagging major version" + $(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version)) + $(GIT_CHGLOG_BIN) --next-tag v$(PROJECT_VERSION) -o $(CHANGELOG_FILE) + $(QUIET) $(GIT) add $(CHANGELOG_FILE) && $(GIT) commit -m "Update changelog" + $(QUIET) $(GIT) tag -a v$(PROJECT_VERSION) -m "Version $(PROJECT_VERSION)" diff --git a/development/makefile/terminal.mk b/development/makefile/terminal.mk index fa2fb145e4db8907ef758a6572246b0b9635e6f9..905b88a161ddcd5fe32958201df6aac8639c88ae 100644 --- a/development/makefile/terminal.mk +++ b/development/makefile/terminal.mk @@ -28,15 +28,13 @@ RSYNC ?= rsync XARGS ?= xargs GREP ?= grep MAKE ?= make -GIT ?= git LN ?= ln -TOUCH ?= touch +TOUCH ?= touch TEST ?= test -JQ ?= jq +JQ ?= jq - -EXECUTABLES = $(EXECUTABLES:-) $(JQ) $(AWK) $(CP) $(KILL) $(MV) $(SED) $(FIND) $(SORT) $(TOUCH) $(WGET) $(CHMOD) $(RSYNC) $(XARGS) $(GREP) $(MAKE) $(GIT) +EXECUTABLES = $(EXECUTABLES:-) $(JQ) $(AWK) $(CP) $(KILL) $(MV) $(SED) $(FIND) $(SORT) $(TOUCH) $(WGET) $(CHMOD) $(RSYNC) $(XARGS) $(GREP) $(MAKE) $(LN) \ No newline at end of file diff --git a/development/makefile/version.mk b/development/makefile/version.mk index da81bea9a379dc08674bb3589a6d2fa02163212c..0f643ee2209221ea08cb31cb6ccd51bef825d8e8 100644 --- a/development/makefile/version.mk +++ b/development/makefile/version.mk @@ -6,10 +6,8 @@ ############################################################################################# ############################################################################################# -VERSION_BIN := version -EXECUTABLES = $(EXECUTABLES:-) $(VERSION_BIN) - -RELEASE_FILE ?= $(PROJECT_ROOT)release.json +VERSION_BIN ?= $(VENDOR_PATH)version +RELEASE_FILE ?= $(PROJECT_ROOT)release.json ifeq ("$(wildcard $(RELEASE_FILE))","") $(shell echo '{"version":"0.1.0"}' > $(RELEASE_FILE)) @@ -17,24 +15,3 @@ endif PROJECT_VERSION ?= $(shell cat $(RELEASE_FILE) | jq -r .version) PROJECT_BUILD_DATE ?= $(shell $(VERSION_BIN) date) - -.PHONY: next-patch-version -## create next patch version -next-patch-version: - $(ECHOMARKER) "Creating next version" - $(QUIET) $(VERSION_BIN) patch --path $(RELEASE_FILE) --selector "version" - $(QUIET) $(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version)) - -.PHONY: next-minor-version -## create next minor version -next-minor-version: - $(ECHOMARKER) "Creating next minor version" - $(QUIET) $(VERSION_BIN) minor --path $(RELEASE_FILE) --selector "version" - $(QUIET) $(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version)) - -.PHONY: next-major-version -## create next major version -next-major-version: - $(ECHOMARKER) "Creating next minor version" - $(QUIET) $(VERSION_BIN) major --path $(RELEASE_FILE) --selector "version" - $(QUIET) $(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version))