diff --git a/development/makefile/changelog.mk b/development/makefile/changelog.mk index 02f1563e9a4f851493fd64abe232a2c64ce8dd51..c3ae83114f80b47c10e7d99bb4a8c89eefeaa334 100644 --- a/development/makefile/changelog.mk +++ b/development/makefile/changelog.mk @@ -8,6 +8,8 @@ GIT_CHGLOG_BIN := $(shell command -v git-chglog 2> /dev/null) +GIT_CHGLOG_CONFIG_DIR := $(PROJECT_ROOT).chglog +REPOSURL := $(subst .git,,$(subst $(shell git config --get user.name)@,,$(shell git config --get remote.origin.url))) ifeq ($(GO),) $(error $(ERRORMARKER) GO is not defined) @@ -15,8 +17,124 @@ endif ifeq ($(GIT_CHGLOG_BIN),) $(shell $(GO) install github.com/git-chglog/git-chglog/cmd/git-chglog@latest) + GIT_CHGLOG_BIN := $(shell command -v git-chglog 2> /dev/null) endif + +ifneq ($(shell test -d $(GIT_CHGLOG_CONFIG_DIR) && echo -n yes),yes) + $(shell mkdir -p $(GIT_CHGLOG_CONFIG_DIR)) +endif + +remove-config-files: + $(shell rm -Rf $(GIT_CHGLOG_CONFIG_DIR)/ && mkdir -p $(GIT_CHGLOG_CONFIG_DIR)) + +.PHONY: update-chglog-files +## update standard git-chglog configuration files +update-chglog-files: remove-config-files $(GIT_CHGLOG_CONFIG_DIR)/config.yml $(GIT_CHGLOG_CONFIG_DIR)/CHANGELOG.tpl.md + $(ECHOMARKER) "update standard git-chglog configuration files" + +define GIT_CHGLOG_CONFIG_FILE +style: gitlab +template: CHANGELOG.tpl.md +info: + title: CHANGELOG + repository_url: $(REPOSURL) +options: + commits: + filters: + Type: + - feat + - fix + - doc + - refactor + - perf + - test + - chore + ## deprecated types and typos + - docs + - documentation + - feat + - added + - add + - bugfix + - revert + - update + - updates + - change + - changed + commit_groups: + title_maps: + feat: Add Features + fix: Bug Fixes + doc: Documentation + refactor: Code Refactoring + perf: Performance Improvements + test: Tests + ## Chore is used for all other changes that don't fit in the other categories + chore: Changes + ## deprecated types and typos + docs: Documentation + documentation: Documentation + added: Add Features + add: Add Features + bugfix: Bug Fixes + revert: Reverts + update: Changes + updates: Changes + change: Changes + changed: Changes + header: + pattern: "^(\\w*)(?:\\(([\\w\\$$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$$" + pattern_maps: + - Type + - Scope + - Subject + notes: + keywords: + - BREAKING CHANGE +endef + +export GIT_CHGLOG_CONFIG_FILE + +$(GIT_CHGLOG_CONFIG_DIR)/config.yml: + $(QUIET) $(ECHO) "$$GIT_CHGLOG_CONFIG_FILE" >> $@ + +define GIT_CHGLOG_CONFIG_TEMPLATE +{{ range .Versions }} +<a name="{{ .Tag.Name }}"></a> +## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }} +{{ range .CommitGroups -}} +### {{ .Title }} +{{ range .Commits -}} +- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }} +{{ end }} +{{ end -}} + +{{- if .NoteGroups -}} +{{ range .NoteGroups -}} +### {{ .Title }} +{{ range .Notes }} +{{ .Body }} +{{ end }} +{{ end -}} +{{ end -}} +{{ end -}} + +{{- if .Versions }} +{{ range .Versions -}} +{{ if .Tag.Previous -}} +[{{ .Tag.Name }}]: {{ $$.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }} +{{ end -}} +{{ end -}} +{{ end -}} +endef + +export GIT_CHGLOG_CONFIG_TEMPLATE + + +$(GIT_CHGLOG_CONFIG_DIR)/CHANGELOG.tpl.md: + $(QUIET) $(ECHO) "$$GIT_CHGLOG_CONFIG_TEMPLATE" >> $@ + ## location of CHANGELOG.md file CHANGELOG_FILE ?= $(PROJECT_ROOT)CHANGELOG.md -EXECUTABLES = $(EXECUTABLES:-) $(GIT_CHGLOG_BIN) \ No newline at end of file +EXECUTABLES = $(EXECUTABLES:-) $(GIT_CHGLOG_BIN) diff --git a/development/makefile/directories-standard.mk b/development/makefile/directories-standard.mk index aedb8969dff906b0907f0260d27a8ce7aed83d41..7a543a85f6971ba5bcb0d8e18c33a28c1cde0be8 100644 --- a/development/makefile/directories-standard.mk +++ b/development/makefile/directories-standard.mk @@ -26,9 +26,11 @@ SCRIPTS_PATH ?= $(DEVELOPMENT_PATH)script/ DEVELOPMENT_SCRIPTS_PATH ?= $(DEVELOPMENT_PATH)script/ BUILD_PATH ?= $(DEPLOYMENT_PATH)build/ VENDOR_PATH ?= $(DEPLOYMENT_PATH)vendor/ -TEST_PATH ?= $(DEVELOPMENT_PATH)test/ +ALVINE_VENDOR_PATH ?= $(VENDOR_PATH)alvine/ +TEST_PATH ?= $(DEVELOPMENT_PATH)tests/ DEPLOYMENT_SCRIPTS_PATH ?= $(DEPLOYMENT_PATH)script/ +LICENSE_PATH ?= $(PROJECT_ROOT) PROJECT_DIRECTORIES := $(PROJECT_DIRECTORIES) \ $(APPLICATION_PATH) \ @@ -37,11 +39,14 @@ PROJECT_DIRECTORIES := $(PROJECT_DIRECTORIES) \ $(WEB_PATH) \ $(DEPLOYMENT_PATH) \ $(VENDOR_PATH) \ + $(ALVINE_VENDOR_PATH) \ + $(TEST_PATH) \ $(DEVELOPMENT_PATH) \ $(DEVELOPMENT_SCRIPTS_PATH) \ $(DEPLOYMENT_SCRIPTS_PATH) \ $(DOCUMENTATION_PATH) \ $(REQUIREMENT_PATH) \ $(CREDENTIALS_PATH) \ + $(LICENSE_PATH) \ $(BUILD_PATH) - \ No newline at end of file + diff --git a/development/makefile/gitignore.mk b/development/makefile/gitignore.mk index 283b8f721442de93d2f8e05f8ebf12d6348e83a9..3ff75ff7a3b27130d09c06e0c80f05a45eaca0dd 100644 --- a/development/makefile/gitignore.mk +++ b/development/makefile/gitignore.mk @@ -8,8 +8,13 @@ define GITIGNOREDS +# Makefile comes from update Makefile.example +# Vendor +/development/vendor/ +/deployment/vendor/ + # 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 @@ -518,8 +523,8 @@ tags endef export GITIGNOREDS -.gitignore: - $(QUITE) $(ECHO) "$$GITIGNOREDS" >> $@ +$(PROJECT_ROOT).gitignore: + $(QUIET) $(ECHO) "$$GITIGNOREDS" >> $@ diff --git a/development/makefile/go.mk b/development/makefile/go.mk index 00ff9478e3e0d69e4370abb88dcaca5f88185437..6cb58e936eb9de9c2d1e3a463c9f2233338c7c5f 100644 --- a/development/makefile/go.mk +++ b/development/makefile/go.mk @@ -14,3 +14,14 @@ 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 + +GOPATH=$(shell go env GOPATH) + +ifeq ($(GOPATH),) + DIRS := bin pkg src + GOPATH=$(DEPLOYMENT_PATH)/go/ + $(shell mkdir -p $(GOPATH)) + $(shell $(foreach entry,$(DIRS),mkdir -p "$(GOPATH)$(entry)";)) + export PATH=$(PATH):$(GOPATH)/bin +endif + diff --git a/development/makefile/jsdoc-json.mk b/development/makefile/jsdoc-json.mk index 321ef66bd7850988eca489aa595f10b1f6b1c461..e5315ac4d52e02c5e908b0d8295feb4ee1339d8c 100644 --- a/development/makefile/jsdoc-json.mk +++ b/development/makefile/jsdoc-json.mk @@ -112,4 +112,4 @@ endef export JSDOCJSON $(DEPLOYMENT_PATH)jsdoc.json: - $(QUITE) $(ECHO) "$$JSDOCJSON" >> $@ \ No newline at end of file + $(QUIET) $(ECHO) "$$JSDOCJSON" >> $@ \ No newline at end of file diff --git a/development/makefile/license-agpl3.mk b/development/makefile/license-agpl3.mk index 6c3e73e274536102d475d8bbf2a035df39a92453..9b3a5a9fa2093cf57953e04be5dce0d2079f44c8 100644 --- a/development/makefile/license-agpl3.mk +++ b/development/makefile/license-agpl3.mk @@ -15,5 +15,686 @@ SPDX_LICENSE_ID ?= AGPL-3.0 ## Copyright holder of the project COPYRIGHT_TEXT ?= © schukai GmbH, Released under the $(LICENSE_TEXT) License. +## Copyright URL +COPYRIGHT_URL ?= [AGPL](https://www.gnu.org/licenses/agpl-3.0.de.html) + ## The owner of the project -COPYRIGHT_OWNER ?= schukai GmbH \ No newline at end of file +COPYRIGHT_OWNER ?= schukai GmbH + + +define LICENSE_FILE_CONTENT +LICENSE + +* All content residing under the "documentation/" directory of this repository is licensed under "Creative Commons: CC BY-SA 4.0 license". +* All content that resides under the "application/" directory of this repository, if that directory exists, is licensed under the license defined in "application/LICENSE". +* All third-party components that are integrated into our software are licensed under the original licence provided by the owner of the respective component. +* Content outside the above directories or restrictions is available under the "AGPL 3.0" licence as defined here: https://www.gnu.org/licenses/agpl-3.0.en.html + +endef + + +define LICENSE_AGPL_FILE_CONTENT + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +<https://www.gnu.org/licenses/>. +endef + + diff --git a/development/makefile/license-all-rights-reserved.mk b/development/makefile/license-all-rights-reserved.mk index c5f61f224a51b8461ecd0a42a887989de30a5aaa..ea690fc4393b20a2f36b1e1811ec3c1b73518efc 100644 --- a/development/makefile/license-all-rights-reserved.mk +++ b/development/makefile/license-all-rights-reserved.mk @@ -16,4 +16,40 @@ SPDX_LICENSE_ID ?= COPYRIGHT_TEXT ?= © schukai GmbH, $(LICENSE_TEXT). ## The owner of the project -COPYRIGHT_OWNER ?= schukai GmbH \ No newline at end of file +COPYRIGHT_OWNER ?= schukai GmbH + +COPYRIGHT_URL ?= [LICENSE](https://www.schukai.com/) + +define LICENSE_FILE_CONTENT +The schukai Enterprise License (the "Enterprise License"). +Copyright © 2022 schukai GmbH. + +Regarding this Software, schukai GmbH is the licensor and you are the licensee. + +By using the Software, you agree to all the terms and conditions set forth below. + +This software and associated documentation files (the "Software") may be used in production only if you (and any company +you represent) have a valid Enterprise License corresponding to your use. Subject to the preceding sentence, you are free +to modify this Software and to release patches for the Software. You agree that schukai and/or its licensors (as applicable) +retain all right, title and interest in and to all such modifications and/or patches, and that all such modifications +and/or patches may be used, copied, modified, displayed, distributed or otherwise exploited only with a valid Enterprise +License for the appropriate use. Notwithstanding the foregoing, you may copy and modify the Software for development and +testing purposes without requiring a subscription. + +You agree that schukai and/or its licensors (if applicable) retain all right, title and interest in and to all such +modifications. No additional rights are granted to you beyond those expressly set forth herein. Subject to the foregoing, +you may not copy, merge, publish, distribute, sublicense and/or sell the Software. + +THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIMS, DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING OUT +OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE SOFTWARE. + +For any third-party components incorporated into schukai's software, such components are licensed under the original license +provided by the owner of the applicable component. + +endef + + + + diff --git a/development/makefile/license-unlicensed.mk b/development/makefile/license-unlicensed.mk index 42443e1fcdcfc8d00fee53b7ae1206a24548ba47..953b34bb8d7f667ee976c26a4de501d54ab48adf 100644 --- a/development/makefile/license-unlicensed.mk +++ b/development/makefile/license-unlicensed.mk @@ -15,5 +15,7 @@ SPDX_LICENSE_ID ?= ## Copyright holder of the project COPYRIGHT_TEXT ?= © schukai GmbH, $(LICENSE_TEXT). +COPYRIGHT_URL ?= [LICENSE](https://www.schukai.com/) + ## The owner of the project -COPYRIGHT_OWNER ?= schukai GmbH \ No newline at end of file +COPYRIGHT_OWNER ?= schukai GmbH diff --git a/development/makefile/licenses.mk b/development/makefile/licenses.mk index 3de604d2e760527cfa488909352aacb9d4e93027..7d8f56db297745a6cc95f605b29eb8b7949aa2ed 100644 --- a/development/makefile/licenses.mk +++ b/development/makefile/licenses.mk @@ -6,8 +6,10 @@ ############################################################################################# ############################################################################################# -## Files wich should be checked for license headers -LICENSE_FILE_PATTERN ?= ./*(.go|js|php) +ifneq "$(wildcard $(SOURCE_PATH) )" "" + ## Files wich should be checked for license headers + LICENSE_FILE_PATTERN ?= $(shell find $(SOURCE_PATH) -type f \( -iname \*.go -o -iname \*.php -o -iname \*.js -o -iname \*.mjs -o -iname \*.cjs \) ) +endif # https://spdx.github.io/spdx-spec/v2.3/SPDX-license-list/ ADDLICENSE_BIN ?= addlicense @@ -16,4 +18,4 @@ ifeq ($(shell command -v $(ADDLICENSE_BIN) 2> /dev/null),) EXECUTABLES = $(EXECUTABLES:-) $(ADDLICENSE_BIN); endif -EXECUTABLES = $(EXECUTABLES:-) $(ADDLICENSE_BIN) \ No newline at end of file +EXECUTABLES = $(EXECUTABLES:-) $(ADDLICENSE_BIN) diff --git a/development/makefile/node.mk b/development/makefile/node.mk index dc9001f840f222adb45030db5ca6a90578415de1..4c1bf4e4330dbd5511e989adf86143ae8f1eadaf 100644 --- a/development/makefile/node.mk +++ b/development/makefile/node.mk @@ -16,7 +16,7 @@ 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 . -type f -name 'package.json' -not -path '*/node_modules/*' -exec sh -c 'F=$$(dirname {}); echo $${F}/node_modules/.modified' \;) +NODE_MODULES_MODIFIED := $(shell find $(PROJECT_ROOT) -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..." @@ -24,8 +24,10 @@ $(NODE_MODULES_MODIFIED): $(NODE_PACKAGES) DIR=$$(dirname $$p); \ echo "Updating package: $${DIR}" ;\ $(NPM) install --prefix $${DIR} ;\ - done ; \ - touch $(NODE_MODULES_MODIFIED) + if [ -d $${DIR}/node_modules/ ]; then \ + touch $${DIR}/node_modules/.modified ;\ + fi ;\ + done ## Main Develpoment Node Repos NODE_ROOT_DIR ?= $(DEVELOPMENT_PATH) @@ -42,11 +44,12 @@ MOCHA ?= $(NODE_MODULES_BIN_DIR)mocha PACKAGE_JSON ?= $(NODE_ROOT_DIR)package.json -MJS_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.mjs') -MJS_RELATIVE_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.mjs' -exec realpath --relative-to $(PROJECT_ROOT) {} \; ) - -JS_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.js') -JS_RELATIVE_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.js' -exec realpath --relative-to $(PROJECT_ROOT) {} \; ) +ifneq "$(wildcard $(SOURCE_PATH) )" "" + MJS_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.mjs') + MJS_RELATIVE_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.mjs' -exec realpath --relative-to $(PROJECT_ROOT) {} \; ) + JS_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.js') + JS_RELATIVE_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.js' -exec realpath --relative-to $(PROJECT_ROOT) {} \; ) +endif diff --git a/development/makefile/placeholder.mk b/development/makefile/placeholder.mk index c99024c96bfb32c566687f0547c4f01f5d7c9aaa..7b79026ced6a04468d12c2407b5e4838509d69f0 100644 --- a/development/makefile/placeholder.mk +++ b/development/makefile/placeholder.mk @@ -6,4 +6,4 @@ ############################################################################################# ############################################################################################# -COMPONENT_SLUG := $(shell echo "$(COMPONENT_NAME)" | tr '[:upper:]' '[:lower:]') \ No newline at end of file +COMPONENT_SLUG := $(shell echo "$(COMPONENT_NAME)" | tr '[:upper:]' '[:lower:]') diff --git a/development/makefile/target-add-licenses.mk b/development/makefile/target-add-licenses.mk index 05de8221faa39c25ad59221825ede95c0846fdc9..4750f2180582c45de35b7301d20fb14cdcdf8a1d 100644 --- a/development/makefile/target-add-licenses.mk +++ b/development/makefile/target-add-licenses.mk @@ -17,7 +17,11 @@ endif .PHONY: add-licenses ## Add license headers to all go files add-licenses: - $(ECHOMARKER) "Add license headers to all go files" + $(ECHOMARKER) "Add license headers to all sourche files" +ifeq ($(LICENSE_FILE_PATTERN),) + $(error "LICENSE_FILE_PATTERN is not set. Please check your makefile and include the licenses.mk") +endif + ifndef SPDX_LICENSE_ID $(error "SPDX_LICENSE_ID is not defined. Please check your makefile and include the licenses.mk") endif diff --git a/development/makefile/target-conan.mk b/development/makefile/target-conan.mk index 06f3182b47b763334c8c4a0313fbfdd7d6fdc101..4a9a06ff83dd2d43ef85c2955d90e98f67ca6953 100644 --- a/development/makefile/target-conan.mk +++ b/development/makefile/target-conan.mk @@ -6,8 +6,10 @@ ############################################################################################# ############################################################################################# -CONAN_BIN ?= $(VENDOR_PATH)conan -CONAN_CONFIG ?= $(VENDOR_PATH)conan.conf +ifeq ($(CONAN_BIN),) + $(error $(ERRORMARKER) Conan is not defined, check your Makefile if conan.mk is included) +endif + $(CONAN_BIN): $(QUIET) $(MKDIR) -p $(VENDOR_PATH) @@ -16,6 +18,5 @@ $(CONAN_BIN): .PHONY: run-conan ## run conan webserver -run-conan: $(CONAN_BIN) - $(QUIET) $(CONAN_BIN) server serve -config $(CONAN_CONFIG) - +run-conan: $(CONAN_BIN) $(CONAN_CONFIG) + $(QUIET) $(CONAN_BIN) server serve --config $(CONAN_CONFIG) diff --git a/development/makefile/target-go-fetch-licenses.mk b/development/makefile/target-go-fetch-licenses.mk index 242f3d346950f04bdc2ae8bb3d465b0ba9b7ebda..65fe5cdc864b4fafa6cebf21920dff5f65a55a45 100644 --- a/development/makefile/target-go-fetch-licenses.mk +++ b/development/makefile/target-go-fetch-licenses.mk @@ -11,16 +11,22 @@ ifeq ($(GO),) endif GO_MOD_FILE := $(SOURCE_PATH)go.mod +GO_LICENSES_BIN := $(shell command -v go-licenses) + + +ifeq ($(GO_LICENSES_BIN),) + $(shell $(GO) install github.com/google/go-licenses@latest) + GO_LICENSES_BIN := $(shell command -v go-licenses 2> /dev/null) + EXECUTABLES = $(EXECUTABLES:-) go-licenses; +endif 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; endif .PHONY: go-fetch-licenses ## Fetch licenses for all modules -go-fetch-licenses: +go-fetch-licenses: ifeq ($(GO_CURRENT_MODULE),) $(QUIET) $(ECHOERRORMARKER) "no go.mod file found, skipping fetching licenses" else diff --git a/development/makefile/target-init-standard.mk b/development/makefile/target-init-standard.mk index 7a69b0cc41a1a19e4a25cdca993cba7ac3505442..8679e58ea337fe4a06301ac784755a62263eb361 100644 --- a/development/makefile/target-init-standard.mk +++ b/development/makefile/target-init-standard.mk @@ -1,7 +1,7 @@ ############################################################################################# ############################################################################################# ## -## INIT-TARGETS +## INIT-STANDARD ## ############################################################################################# ############################################################################################# @@ -9,12 +9,41 @@ # @see .PHONY https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html#Phony-Targets .PHONY: init-standard +# The default directories are defined in the +# directories-standard.mk file, but all other +# targets can define directories as well. + +$(PROJECT_DIRECTORIES): + $(foreach path,$(PROJECT_DIRECTORIES),\ + $(shell $(MKDIR) -p $(path))) + ## init standard project -init-standard: .gitignore - # The default directories are defined in the - # directories-standard.mk file, but all other - # targets can define directories as well. +init-standard: $(PROJECT_DIRECTORIES) $(PROJECT_ROOT).gitignore $(PROJECT_ROOT)README.md $(LICENSE_PATH)LICENSE $(ECHOMARKER) "Run init-standard" - $(foreach path,$(PROJECT_DIRECTORIES),\ - $(shell $(MKDIR) -p $(path))) $(ECHO) "Done" + +############################################################################################# +############################################################################################# +## +## LICENSE +## +############################################################################################# +############################################################################################# + +export LICENSE_FILE_CONTENT +$(LICENSE_PATH)LICENSE: + $(QUIET) $(ECHO) "$$LICENSE_FILE_CONTENT" >> $@ + +############################################################################################# +############################################################################################# +## +## README +## +############################################################################################# +############################################################################################# + +export README_FILE_CONTENT +$(PROJECT_ROOT)README.md: + $(QUIET) $(ECHO) "$$README_FILE_CONTENT" >> $@ + + diff --git a/development/makefile/target-jekyll.mk b/development/makefile/target-jekyll.mk index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..8890741ae7d1b86664dfb1f264c34db88db10487 100644 --- a/development/makefile/target-jekyll.mk +++ b/development/makefile/target-jekyll.mk @@ -0,0 +1,39 @@ +############################################################################################# +############################################################################################# +## +## JEKYLL-TARGETS +## +############################################################################################# +############################################################################################# + + +JEKYLL_VERSION := snapshot +JEKYLL_BIN := $(ALVINE_VENDOR_PATH)jekyll-$(JEKYLL_VERSION).phar +JEKYLL_PUBKEY := $(JEKYLL_BIN).pubkey + +$(JEKYLL_PUBKEY): + $(MKDIR) -p $(ALVINE_VENDOR_PATH) + $(WGET) -O $(JEKYLL_PUBKEY) http://download.alvine.io/phar/jekyll-$(JEKYLL_VERSION).phar.pubkey + +$(JEKYLL_BIN): $(JEKYLL_PUBKEY) + $(MKDIR) -p $(ALVINE_VENDOR_PATH) + $(WGET) -O $(JEKYLL_BIN) http://download.alvine.io/phar/jekyll-$(JEKYLL_VERSION).phar + $(CHMOD) u+x $(JEKYLL_BIN) + +.PHONY: run-jekyll +## run jekyll +run-jekyll: init $(JEKYLL_BIN) $(JEKYLL_PUBKEY) $(TEMP_PATH)jekyll.lock + $(ECHOMARKER) "Jekyll finished" + +.PHONY: run-jekyll-force +## run jekyll (-f) +run-jekyll-force: init $(JEKYLL_BIN) $(JEKYLL_PUBKEY) + $(RM) $(TEMP_PATH)jekyll.lock + $(MAKE) run-jekyll + $(ECHOMARKER) "Jekyll finished" + +$(TEMP_PATH)jekyll.lock: $(THIS_DIR).jekyll + $(ECHOMARKER) "Run Jekyll" + $(JEKYLL_BIN) fetch --force + $(JEKYLL_BIN) update + touch $(TEMP_PATH)jekyll.lock \ No newline at end of file diff --git a/development/makefile/target-node-build.mk b/development/makefile/target-node-build.mk index 0ee3a09e799f8a6ec873a61f35e220031322a19a..98b4fed6df33172585d2e9e538b8f1d930389d1a 100644 --- a/development/makefile/target-node-build.mk +++ b/development/makefile/target-node-build.mk @@ -17,10 +17,8 @@ node-build: $(NODE_MODULES_MODIFIED) $(NODE_PACKAGES) $(ECHO) "Version: $(PROJECT_VERSION)" $(ECHO) "Source Path: $(SOURCE_PATH)" $(QUIET) $(JQ) '.version = "$(PROJECT_VERSION)"' $(PACKAGE_JSON) | $(SPONGE) $(PACKAGE_JSON) - $(QUIET) for p in $(NODE_PACKAGES); do \ - $(JQ) '.version = "$(PROJECT_VERSION)"' $${p} | $(SPONGE) $${p}; \ - done ; \ - $(NPM) --prefix $(NODE_ROOT_DIR) run build - + $(QUIET) for p in $(NODE_PACKAGES); do $(JQ) '.version = "$(PROJECT_VERSION)"' $${p} | $(SPONGE) $${p}; done + $(QUIET) $(SCRIPTS_PATH)update-version.sh + $(QUIET) $(NPM) --prefix $(NODE_ROOT_DIR) run --if-present build diff --git a/development/makefile/target-npm-publish.mk b/development/makefile/target-npm-publish.mk index 41b1f54d9e105fbb6112377d192f2aaf71960e46..d7f8b391edbf1eecc59b624f479d238e2ad57ba8 100644 --- a/development/makefile/target-npm-publish.mk +++ b/development/makefile/target-npm-publish.mk @@ -8,25 +8,28 @@ .PHONY: npm-publish-major ## release major version of package -npm-publish-major: node-test +npm-publish-major: $(ECHOMARKER) "release major version" - $(QUIET) $(MAKE) next-major-version + $(QUIET) $(MAKE) tag-major-version $(QUIET) $(MAKE) node-build + $(QUIET) $(MAKE) node-test $(QUIET) $(NPM) --prefix $(NODE_ROOT_DIR) run publish .PHONY: npm-publish-minor ## release minor version of package -npm-publish-minor: node-test +npm-publish-minor: $(ECHOMARKER) "release minor version" - $(QUIET) $(MAKE) next-minor-version + $(QUIET) $(MAKE) tag-minor-version $(QUIET) $(MAKE) node-build + $(QUIET) $(MAKE) node-test $(QUIET) $(NPM) --prefix $(NODE_ROOT_DIR) run publish .PHONY: npm-publish-patch ## release patch version of package -npm-publish-patch: node-test +npm-publish-patch: $(ECHOMARKER) "release patch version" - $(QUIET) $(MAKE) next-patch-version + $(QUIET) $(MAKE) tag-patch-version $(QUIET) $(MAKE) node-build + $(QUIET) $(MAKE) node-test $(QUIET) $(NPM) --prefix $(NODE_ROOT_DIR) run publish diff --git a/development/makefile/target-version.mk b/development/makefile/target-version.mk index 63a3457fe6e194349fbefbaee3c14238c28f88b9..71c274d585d03cd082ed39ba7bd8a93973f0f196 100644 --- a/development/makefile/target-version.mk +++ b/development/makefile/target-version.mk @@ -47,7 +47,7 @@ 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 +tag-patch-version: $(GIT_CHGLOG_CONFIG_DIR)/config.yml $(GIT_CHGLOG_CONFIG_DIR)/CHANGELOG.tpl.md 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) @@ -55,7 +55,7 @@ tag-patch-version: next-patch-version $(QUIET) $(GIT) tag -a v$(PROJECT_VERSION) -m "Version $(PROJECT_VERSION)" ## tag repository with next minor version -tag-minor-version: next-minor-version +tag-minor-version: $(GIT_CHGLOG_CONFIG_DIR)/config.yml $(GIT_CHGLOG_CONFIG_DIR)/CHANGELOG.tpl.md 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) @@ -63,7 +63,7 @@ tag-minor-version: next-minor-version $(QUIET) $(GIT) tag -a v$(PROJECT_VERSION) -m "Version $(PROJECT_VERSION)" ## tag repository with next major version -tag-major-version: next-major-version +tag-major-version: $(GIT_CHGLOG_CONFIG_DIR)/config.yml $(GIT_CHGLOG_CONFIG_DIR)/CHANGELOG.tpl.md 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)