Merge pull request #1278 from tdesveauxPKFX/redist_improvement

Packaging script improvement

.gitattributes

@@ -0,0 +1,11 @@
+# Setup archive tags
+
+.DS_Store		export-ignore
+.gitignore		export-ignore
+.gitattributes	export-ignore
+.gitmodules		export-ignore
+.travis.yml		export-ignore
+.editorconfig	export-ignore
+appveyor.yml	export-ignore
+Bootstrap.*		export-ignore
+packages/*		export-ignore

Bootstrap.bat

@@ -0,0 +1,104 @@
+@ECHO OFF
+SETLOCAL
+SETLOCAL ENABLEDELAYEDEXPANSION
+
+SET vsversion=%1
+IF "%vsversion%" == "" (
+	SET vsversion=vs2015
+)
+
+IF "%vsversion%" == "vs2010" (
+	CALL :LegacyVisualBootstrap "%vsversion%" "100"
+
+) ELSE IF "%vsversion%" == "vs2012" (
+	CALL :LegacyVisualBootstrap "%vsversion%" "110"
+
+) ELSE IF "%vsversion%" == "vs2013" (
+	CALL :LegacyVisualBootstrap "%vsversion%" "120"
+
+) ELSE IF "%vsversion%" == "vs2015" (
+	CALL :LegacyVisualBootstrap "%vsversion%" "140"
+
+) ELSE IF "%vsversion%" == "vs2017" (
+	CALL :VsWhereVisualBootstrap "%vsversion%" "15.0" "16.0"
+
+) ELSE IF "%vsversion%" == "vs2019" (
+	CALL :VsWhereVisualBootstrap "%vsversion%" "16.0" "17.0"
+
+) ELSE (
+	ECHO Unrecognized Visual Studio version %vsversion%
+	EXIT /B 2
+)
+
+REM On error, pause to allow user to notice it if script was launched through explorer
+IF %ERRORLEVEL% NEQ 0 (
+	PAUSE
+)
+
+EXIT /B %ERRORLEVEL%
+
+REM ===========================================================================
+
+REM Utils
+
+REM ===========================================================================
+
+REM %1: PremakeVsVersion -> ex: vs2015
+REM %2: VsVersion envvar -> ex: 140
+:LegacyVisualBootstrap
+
+SET "VsVersion_NoPoint=%~2"
+SET "VsEnvVar=VS%VsVersion_NoPoint%COMNTOOLS"
+SET "VsPath=!%VsEnvVar%!"
+
+IF NOT EXIST "%VsPath%vsdevcmd.bat" (
+	ECHO Could not find vsdevcmd.bat to setup Visual Studio environment
+	EXIT /B 2
+)
+
+CALL "%VsPath%vsdevcmd.bat" && nmake MSDEV="%~1" -f Bootstrap.mak windows
+EXIT /B %ERRORLEVEL%
+
+REM :LegacyVisualBootstrap
+
+
+REM ===========================================================================
+
+REM %1: PremakeVsVersion -> ex: vs2010
+REM %2: VisualStudio-style VSversionMin -> ex: 15.0
+REM %3: VisualStudio-style VSversionMax -> ex: 16.0
+:VsWhereVisualBootstrap
+SET "PremakeVsVersion=%~1"
+SET "VsVersionMin=%~2"
+SET "VsVersionMax=%~3"
+
+REM ref: https://github.com/Microsoft/vswhere/wiki/Start-Developer-Command-Prompt
+
+SET VsWherePath="C:/Program Files (x86)/Microsoft Visual Studio/Installer/vswhere.exe"
+
+IF NOT EXIST %VsWherePath% (
+	ECHO Could not find vswhere.exe
+	EXIT /B 2
+)
+
+SET VsWhereCmdLine="%VsWherePath% -nologo -latest -version [%VsVersionMin%,%VsVersionMax%) -property installationPath"
+
+FOR /F "usebackq delims=" %%i in (`!VsWhereCmdLine!`) DO (
+
+	IF EXIST "%%i\VC\Auxiliary\Build\vcvars32.bat" (
+		CALL "%%i\VC\Auxiliary\Build\vcvars32.bat" && nmake MSDEV="%PremakeVsVersion%" -f Bootstrap.mak windows
+		EXIT /B %ERRORLEVEL%
+	)
+)
+
+ECHO Could not find vcvars32.bat to setup Visual Studio environment
+EXIT /B 2
+
+REM :VsWhereVisualBootstrap
+
+REM ===========================================================================
+
+REM SETLOCAL ENABLEDELAYEDEXPANSION
+ENDLOCAL
+REM SETLOCAL
+ENDLOCAL

Bootstrap.mak

@@ -61,6 +61,8 @@ mingw: $(SRC)
 	./build/bootstrap/premake_bootstrap --os=windows --to=build/bootstrap gmake
 	$(MAKE) -C build/bootstrap config=$(CONFIG)_$(PLATFORM)
 
+macosx: osx
+
 osx: $(SRC)
 	$(SILENT) rm -rf ./bin
 	$(SILENT) rm -rf ./build

scripts/package.lua

@@ -20,27 +20,68 @@
 -- Check the command line arguments, and show some help if needed.
 ---
 
-	local usage = 'usage is: package <branch> <type>\n' ..
+	local allowedCompilers = {}
-		'       <branch> is the name of the release branch to target\n' ..
-		'       <type> is one of "source" or "binary"\n'
 
-	if #_ARGS ~= 2 then
+	if os.ishost("windows") then
+		allowedCompilers = {
+			"vs2019",
+			"vs2017",
+			"vs2015",
+			"vs2013",
+			"vs2012",
+			"vs2010",
+			"vs2008",
+			"vs2005",
+		}
+	elseif os.ishost("linux") or os.ishost("bsd") then
+		allowedCompilers = {
+			"gcc",
+			"clang",
+		}
+	elseif os.ishost("macosx") then
+		allowedCompilers = {
+			"clang",
+		}
+	else
+		error("Unsupported host os", 0)
+	end
+
+	local usage = 'usage is: package <branch> <type> [<compiler>]\n' ..
+		'       <branch> is the name of the release branch to target\n' ..
+		'       <type> is one of "source" or "binary"\n' ..
+		'       <compiler> (default: ' .. allowedCompilers[1] .. ') is one of ' .. table.implode(allowedCompilers, "", "", " ")
+
+	if #_ARGS ~= 2 and #_ARGS ~= 3 then
 		error(usage, 0)
 	end
 
 	local branch = _ARGS[1]
 	local kind = _ARGS[2]
+	local compiler = _ARGS[3] or allowedCompilers[1]
 
 	if kind ~= "source" and kind ~= "binary" then
+		print("Invalid package kind: "..kind)
 		error(usage, 0)
 	end
 
+	if not table.contains(allowedCompilers, compiler) then
+		print("Invalid compiler: "..compiler)
+		error(usage, 0)
+	end
+
+	local compilerIsVS = compiler:startswith("vs")
 
 --
 -- Make sure I've got what I've need to be happy.
 --
 
-	local required = { "git", "make", "gcc", "premake5", "zip" }
+	local required = { "git" }
+
+	if not compilerIsVS then
+		table.insert(required, "make")
+		table.insert(required, compiler)
+	end
+
 	for _, value in ipairs(required) do
 		local z = execQuiet("%s --version", value)
 		if not z then
@@ -88,22 +129,27 @@
 	os.rmdir(pkgName)
 
 	print("Cloning source code")
-	z = os.executef("git clone .. %s", pkgName)
+	local z = execQuiet("git clone .. %s -b %s --recurse-submodules --depth 1 --shallow-submodules", pkgName, branch)
 	if not z then
 		error("clone failed", 0)
 	end
 
 	os.chdir(pkgName)
 
-	z = os.executef("git checkout %s", branch)
+--
-	if not z then
+-- Bootstrap Premake in the newly cloned repository
-		error("unable to checkout branch " .. branch, 0)
+--
-	end
 
-	z = os.executef("git submodule update --init")
+	print("Bootstraping Premake...")
-	if not z then
+	if compilerIsVS then
-		error("unable to clone submodules", 0)
+		z = os.execute("Bootstrap.bat " .. compiler)
+	else
+		z = os.execute("make -j -f Bootstrap.mak " .. os.host())
 	end
+	if not z then
+		error("Failed to Bootstrap Premake", 0)
+	end
+	local premakeBin = path.translate("bin/release/Premake5")
 
 
 --
@@ -111,56 +157,73 @@
 --
 
 	print("Updating embedded scripts...")
-	if kind == "source" then
+
-		z = execQuiet("premake5 embed")
+	local z = execQuiet("%s embed %s", premakeBin, iif(kind == "source", "", "--bytecode"))
-	else
-		z = execQuiet("premake5 --bytecode embed")
-	end
 	if not z then
 		error("failed to update the embedded scripts", 0)
 	end
 
 
---
--- Clear out files I don't want included in any packages.
---
-
-	print("Cleaning up the source tree...")
-	os.rmdir("packages")
-	os.rmdir(".git")
-
-	local removelist = { ".DS_Store", ".git", ".gitignore", ".gitmodules", ".travis.yml", ".editorconfig", "appveyor.yml", "Bootstrap.mak" }
-	for _, removeitem in ipairs(removelist) do
-		local founditems = os.matchfiles("**" .. removeitem)
-		for _, item in ipairs(founditems) do
-			os.remove(item)
-		end
-	end
-
 --
 -- Generate a source package.
 --
 
 if kind == "source" then
 
+	local function	genProjects(parameters)
+		if not execQuiet("%s %s", premakeBin, parameters) then
+			error("failed to generate project for "..parameters, 0)
+		end
+	end
+
+	os.rmdir("build")
+
 	print("Generating project files...")
-	execQuiet("premake5 /to=build/vs2005 vs2005")
+
-	execQuiet("premake5 /to=build/vs2008 vs2008")
+	local ignoreActions = {
-	execQuiet("premake5 /to=build/vs2010 vs2010")
+		"clean",
-	execQuiet("premake5 /to=build/vs2012 vs2012")
+		"embed",
-	execQuiet("premake5 /to=build/vs2013 vs2013")
+		"gmake2",
-	execQuiet("premake5 /to=build/vs2015 vs2015")
+		"package",
-	execQuiet("premake5 /to=build/vs2017 vs2017")
+		"test",
-	execQuiet("premake5 /to=build/vs2019 vs2019")
+
-	execQuiet("premake5 /to=build/gmake.windows /os=windows gmake")
+		"codelite",
-	execQuiet("premake5 /to=build/gmake.unix /os=linux gmake")
+		"xcode4",
-	execQuiet("premake5 /to=build/gmake.macosx /os=macosx gmake")
+	}
-	execQuiet("premake5 /to=build/gmake.bsd /os=bsd gmake")
+
+	for action in premake.action.each() do
+
+		if not table.contains(ignoreActions, action.trigger) then
+			if action.trigger == "gmake" then
+
+				local gmakeOsList = {
+					{ "windows", },
+					{ "unix", "linux" },
+					{ "macosx", },
+					{ "bsd", },
+				}
+
+				for _, os in ipairs(gmakeOsList) do
+					local osTarget = os[2] or os[1]
+					genProjects(string.format("--to=build/gmake.%s --os=%s gmake", os[1], osTarget))
+				end
+			else
+				genProjects(string.format("--to=build/%s %s", action.trigger, action.trigger))
+			end
+		end
+	end
 
 	print("Creating source code package...")
-	os.chdir("..")
-	execQuiet("zip -r9 %s-src.zip %s/*", pkgName, pkgName)
 
+	if 	not execQuiet("git add -f build") or
+		not execQuiet("git stash") or
+		not execQuiet("git archive --format=zip -9 -o ../%s-src.zip --prefix=%s/ stash@{0}", pkgName, pkgName) or
+		not execQuiet("git stash drop stash@{0}")
+	then
+		error("failed to archive release", 0)
+	end
+
+	os.chdir("..")
 end
 
 
@@ -173,22 +236,28 @@ end
 if kind == "binary" then
 
 	print("Building binary...")
-	execQuiet("premake5 gmake")
-	z = execQuiet("make config=release")
-	if not z then
-		error("build failed")
-	end
 
 	os.chdir("bin/release")
 
-	local name = string.format("%s-%s%s", pkgName, os.host(), pkgExt)
+	local addCommand = "git add -f premake5%s"
+	local archiveCommand = "git archive --format=%s -o ../../../%s-%s%s stash@{0} -- ./premake5%s"
+
 	if os.ishost("windows") then
-		execQuiet("zip -9 %s premake5.exe", name)
+		addCommand = string.format(addCommand, ".exe")
+		archiveCommand = string.format(archiveCommand, "zip -9", pkgName, os.host(), pkgExt, ".exe")
 	else
-		execQuiet("tar czvf %s premake5", name)
+		addCommand = string.format(addCommand, "")
+		archiveCommand = string.format(archiveCommand, "tar.gz", pkgName, os.host(), pkgExt, "")
+	end
+
+	if 	not execQuiet(addCommand) or
+		not execQuiet("git stash") or
+		not execQuiet(archiveCommand) or
+		not execQuiet("git stash drop stash@{0}")
+	then
+		error("failed to archive release", 0)
 	end
 
-	os.copyfile(name, path.join("../../../", name))
 	os.chdir("../../..")
 
 end
@@ -198,4 +267,5 @@ end
 -- Clean up
 --
 
-	os.rmdir(pkgName)
+	-- Use RMDIR token instead of os.rmdir to force remove .git dir which has read only files
+	execQuiet(os.translateCommands("{RMDIR} "..pkgName))