UnrealEngine/Plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

determine the value of mdbook site-url from the makefile instead of hardcoding it per branch

Browse Source
This commit is contained in:
Mamadou Babaei
2024-08-16 15:12:12 +02:00
parent d40ace3c58
commit 674f6c4f59
2 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Handbook/GNUmakefile
+12 -10
View File
@@ -124,8 +124,7 @@ SG_GIT_COMMIT := $(shell git rev-parse --short HEAD 2>/dev/null)
SG_GIT_COMMIT_NUMS_SINCE_TAG := $(shell git rev-list --count HEAD ^`git describe --tags --abbrev=0 2>/dev/null` 2>/dev/null)
SG_GIT_TREE_STATE := $(shell test -n "`git status --porcelain 2>/dev/null`" && echo "dirty" || echo "clean")
SG_PLUGIN_VERSION := $(shell grep -o '"VersionName": "[^"]*"' ${SG_PLUGIN_FILE} | awk -F'"' '{print "v" $$4}')
SG_HANDBOOK_SITE_URL := $(shell grep '^site-url' $(SG_HANDBOOK_TOML_FILE) | sed -n 's|^site-url = "/\(.*\)/"|\1|p')
SG_PLUGIN_VERSION := $(shell grep -o '"VersionName": "[^"]*"' ${SG_PLUGIN_FILE} | awk -F'"' '{print "v" $$4}')
ifeq ($(strip $(SG_GIT_COMMIT_NUMS_SINCE_TAG)),)
SG_GIT_COMMIT_NUMS_SINCE_TAG := 0
@@ -170,40 +169,41 @@ SG_BUILD_TIME := $(shell date '+%a %b %d, %Y %H:%M %Z %z')
ifeq ($(strip $(SG_GIT_BRANCH)),dev)
ifeq ($(strip $(SG_GIT_VERSION)),)
ifeq ($(strip $(SG_HANDBOOK_SITE_URL)),next)
SG_HANDBOOK_REVISION := next
endif # ($(strip $(SG_HANDBOOK_SITE_URL)),next)
endif # ($(strip $(SG_GIT_VERSION)),)
endif # ($(strip $(SG_GIT_BRANCH)),dev)
SG_IS_GIT_BRANCH_HEAD_OR_MASTER := $(or $(filter HEAD,$(strip $(SG_GIT_BRANCH))),$(filter master,$(strip $(SG_GIT_BRANCH))))
ifeq ($(SG_IS_GIT_BRANCH_HEAD_OR_MASTER),1)
ifneq ($(SG_IS_GIT_BRANCH_HEAD_OR_MASTER),)
ifeq ($(strip $(SG_GIT_COMMIT_NUMS_SINCE_TAG)),0)
ifeq ($(strip $(SG_GIT_TREE_STATE)),clean)
ifeq ($(strip $(SG_GIT_VERSION)),$(strip $(SG_PLUGIN_VERSION)))
ifeq ($(strip $(SG_HANDBOOK_SITE_URL)),$(strip $(SG_PLUGIN_VERSION_MAJOR).$(SG_PLUGIN_VERSION_MINOR)))
SG_HANDBOOK_REVISION := SG_PLUGIN_VERSION_MAJOR.SG_PLUGIN_VERSION_MINOR
endif # ($(strip $(SG_HANDBOOK_SITE_URL)),$(strip $(SG_PLUGIN_VERSION_MAJOR).$(SG_PLUGIN_VERSION_MINOR)))
SG_HANDBOOK_REVISION := $(SG_PLUGIN_VERSION_MAJOR).$(SG_PLUGIN_VERSION_MINOR)
endif # ($(strip $(SG_GIT_VERSION)),$(strip $(SG_PLUGIN_VERSION)))
endif # ($(strip $(SG_GIT_TREE_STATE)),clean)
endif # ($(strip $(SG_GIT_COMMIT_NUMS_SINCE_TAG)),0)
endif # ($(SG_IS_GIT_BRANCH_HEAD_OR_MASTER),1)
endif # ($(SG_IS_GIT_BRANCH_HEAD_OR_MASTER),)
ifeq ($(strip $(SG_HANDBOOK_REVISION)),)
SG_HANDBOOK_REVISION := mismatched
endif # ($(strip $(SG_HANDBOOK_REVISION)),)
ifneq ($(strip $(SG_HANDBOOK_REVISION)),mismatched)
SG_MDBOOK_HTML_SITE_URL := $(SG_HANDBOOK_REVISION)
SG_HANDBOOK_REVISION_URL := $(SG_DOCUMENTATION_URL)/$(SG_HANDBOOK_REVISION)
SG_HANDBOOK_RELEASE_NAME := $(shell echo $(SG_PROJECT_NAME)-$(SG_HANDBOOK_REVISION) | tr '[:upper:]' '[:lower:]' | sed 's/ /-/g')
SG_HANDBOOK_PDF_URL := $(SG_HANDBOOK_REVISION_URL)/$(SG_HANDBOOK_RELEASE_NAME).pdf
endif
endif # ($(strip $(SG_HANDBOOK_REVISION)),mismatched)
################################################################################
# mdbook-pdf Configuration
################################################################################
ifneq ($(strip $(SG_HANDBOOK_REVISION)),mismatched)
SG_MDBOOK_HTML_SITE_URL := /$(SG_HANDBOOK_REVISION)/
endif # ($(strip $(SG_HANDBOOK_REVISION)),mismatched)
ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX))
SG_MDBOOK_PDF_BROWSER_BINARY_PATH := $(SG_BROWSER_BINARY_PATH_LINUX)
else ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_WINDOWS))
@@ -434,6 +434,7 @@ _mdbook_serve:
SG_PLUGIN_VERSION_PATCH='$(SG_PLUGIN_VERSION_PATCH)' \
SG_BUILD_HOST='$(SG_BUILD_HOST)' \
SG_BUILD_TIME='$(SG_BUILD_TIME)' \
MDBOOK_output__html__site_url='$(SG_MDBOOK_HTML_SITE_URL)' \
MDBOOK_output__pdf__browser_binary_path='$(SG_MDBOOK_PDF_BROWSER_BINARY_PATH)' \
mdbook serve \
-n $(SG_MDBOOK_HOST) \
@@ -463,6 +464,7 @@ _mdbook_build:
SG_PLUGIN_VERSION_PATCH='$(SG_PLUGIN_VERSION_PATCH)' \
SG_BUILD_HOST='$(SG_BUILD_HOST)' \
SG_BUILD_TIME='$(SG_BUILD_TIME)' \
MDBOOK_output__html__site_url='$(SG_MDBOOK_HTML_SITE_URL)' \
MDBOOK_output__pdf__browser_binary_path='$(SG_MDBOOK_PDF_BROWSER_BINARY_PATH)' \
mdbook build \
--dest-dir $(SG_MDBOOK_DEST_DIR)
Handbook/book.toml
-1
View File
@@ -61,7 +61,6 @@ input-404 = "404.md"
mathjax-support = false
no-section-label = false
preferred-dark-theme = "navy"
site-url = "/next/"
smart-punctuation = false
theme = ""