rock-n-code/amiibo-service
1
0
Fork 0
Code Issues 1 Pull Requests Releases 8 Wiki Activity

Added some targets to the Makefile file to smooth the current development workflows;

Browse Source
This commit is contained in:
Javier Cicchelli 2023-04-29 01:42:09 +02:00
parent a93e5a1cb2
commit 67b60e752e
1 changed files with 82 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
Makefile
View File

@ -6,46 +6,111 @@ environment_vars ?= .env
include $(environment_vars) include $(environment_vars)
export $(shell sed 's/=.*//' $(environment_vars)) export $(shell sed 's/=.*//' $(environment_vars))
# --- ARGUMENTS ---
override docker?=${CLI_USE_DOCKER}
override tag?=${DOCKER_IMAGE_TAG}
override platform?=${DOCKER_IMAGE_PLATFORM}
override config?=${SWIFT_BUILD_CONFIGURATION}
override clean?=${DOCKER_IMAGE_CLEAN}
# --- DEPENDENCIES ---
outdated: ## List the package dependencies that can be updated.
@swift package update --dry-run
update: ## Update the package dependencies.
@swift package update
# --- DEVELOPMENT ---
build: ## Build this package with Swift either locally or in a Docker image.
ifeq ($(docker),yes)
@-docker run \
--rm \
--volume ${PWD}:${DOCKER_VOLUME_TARGET} \
--workdir ${DOCKER_VOLUME_TARGET} \
--platform ${platform} \
${DOCKER_IMAGE_NAME}:${tag} \
swift build --configuration ${config}
ifeq ($(clean),yes)
@docker rmi ${DOCKER_IMAGE_NAME}:${tag}
endif
else
@swift build --configuration ${config}
endif
# --- TESTING ---
test: ## Test this package with Swift either locally or in a Docker image.
ifeq ($(docker),yes)
@-docker run \
--rm \
--volume ${PWD}:${DOCKER_VOLUME_TARGET} \
--workdir ${DOCKER_VOLUME_TARGET} \
--platform ${platform} \
${DOCKER_IMAGE_NAME}:${tag} \
swift test --configuration ${config}
ifeq ($(clean),yes)
@docker rmi ${DOCKER_IMAGE_NAME}:${tag}
endif
else
@swift test --configuration ${config}
endif
# --- DOCUMENTATION --- # --- DOCUMENTATION ---
preview-doc: ## Previews the project documentation for web. preview-doc: ## Preview the documentation in Safari.
@open -a safari $(SWIFT_DOC_PREVIEW_URL) @open -a safari $(DOCC_PREVIEW_URL)
@swift package \ @swift package \
--disable-sandbox \ --disable-sandbox \
preview-documentation \ preview-documentation \
--target $(SWIFT_TARGET_NAME) --target $(SWIFT_TARGET_NAME)
generate-docs: generate-doc-xcode generate-doc-github ## Generates the project documentation for Xcode and Github. generate-docs: generate-doc-xcode generate-doc-github ## Generate the documentation for Xcode and Github pages.
generate-doc-xcode: generate-doc-xcode:
@echo Generating documentation for Xcode...
@swift package \ @swift package \
--allow-writing-to-directory $(SWIFT_DOC_XCODE_OUTPUT) \ --allow-writing-to-directory $(DOCC_XCODE_OUTPUT) \
generate-documentation \ generate-documentation \
--target $(SWIFT_TARGET_NAME) \ --target $(SWIFT_TARGET_NAME) \
--output-path $(SWIFT_DOC_XCODE_OUTPUT) --output-path $(DOCC_XCODE_OUTPUT)
generate-doc-github: generate-doc-github:
@echo Generating documentation for Github pages...
@swift package \ @swift package \
--allow-writing-to-directory $(SWIFT_DOC_GITHUB_OUTPUT) \ --allow-writing-to-directory $(DOCC_GITHUB_OUTPUT) \
generate-documentation \ generate-documentation \
--target $(SWIFT_TARGET_NAME) \ --target $(SWIFT_TARGET_NAME) \
--disable-indexing \ --disable-indexing \
--transform-for-static-hosting \ --transform-for-static-hosting \
--hosting-base-path $(SWIFT_DOC_GITHUB_BASE_PATH) \ --hosting-base-path $(DOCC_GITHUB_BASE_PATH) \
--output-path $(SWIFT_DOC_GITHUB_OUTPUT) --output-path $(DOCC_GITHUB_OUTPUT)
clean-docs: ## Cleans up the generated documentation for Xcode and Github pages. # --- HOUSE-KEEPING ---
ifeq ("$(shell test -e ${SWIFT_DOC_GITHUB_OUTPUT} && echo yes)","yes")
@echo Cleaning up the Github pages folder... clean: ## Clean the build artifacts.
@rm -rf ${SWIFT_DOC_GITHUB_OUTPUT} @swift package clean
reset: ## Reset the build folder.
@swift package reset
flush-docs: ## Flush the documentation for Xcode and Github pages.
ifeq ("$(shell test -e ${DOCC_GITHUB_OUTPUT} && echo yes)","yes")
@rm -rf ${DOCC_GITHUB_OUTPUT}
endif endif
ifeq ("$(shell test -e ${SWIFT_DOC_XCODE_OUTPUT} && echo yes)","yes") ifeq ("$(shell test -e ${DOCC_XCODE_OUTPUT} && echo yes)","yes")
@echo Cleaning up the Xcode documentation archive... @rm -rf ${DOCC_XCODE_OUTPUT}
@rm -rf ${SWIFT_DOC_XCODE_OUTPUT}
endif endif
flush-images: ## Flush all outstanding Swift docker images.
@docker images \
--all | grep ${DOCKER_IMAGE_NAME} | awk '{print $$3}' | xargs docker rmi --force
# --- MISCELLANEOUS ---
xcode: ## Open this package in Xcode.
@open -a Xcode Package.swift
# --- HELP --- # --- HELP ---
# Outputs the documentation for each of the defined tasks when `help` is called. # Outputs the documentation for each of the defined tasks when `help` is called.