Add `xmake pack` command to generate installation package like cmake/cpack #1433

waruqi · 2021-06-01T00:14:47Z

waruqi · 2023-11-15T03:42:57Z

New Scope Apis (xpack)

we can call includes("@builtin/xpack") to import xpack() apis.

includes("@builtin/xpack")

xpack("test")
    set_formats("nsis")
    set_description("hello")
    add_targets("test", "foo")

local apis = {
    values = {
        -- set package version,  we will also get it from project/target
        "xpack.set_version",
        -- set package homepage url
        "xpack.set_homepage",
        -- set package title
        "xpack.set_title",
        -- set author
        "xpack.set_author",
        -- set maintainer,
        "xpack.set_maintainer",
        -- set package description
        "xpack.set_description",
        -- set input kind, e.g. binary, source
        "xpack.set_inputkind",
        -- set package copyright
        "xpack.set_copyright",
        -- set company name
        "xpack.set_company",
        -- set package formats, e.g. nsis, deb, rpm, targz, zip, srctargz, srczip, runself, ...
        -- we can also add custom formats
        "xpack.set_formats",
        -- set the base name of the output file
        "xpack.set_basename",
        -- set the extension of the output file
        "xpack.set_extension",
        -- add targets to be packaged
        "xpack.add_targets",
        -- add package components
        "xpack.add_components",
        -- set installed binary directory, e.g. bin
        "xpack.set_bindir",
        -- set installed library directory, e.g. lib
        "xpack.set_libdir",
        -- set installed include directory, e.g. include
        "xpack.set_includedir",
        -- set prefix directory, e.g. prefixdir/bin, prefixdir/lib ..
        "xpack.set_prefixdir",
        -- set nsis display icon
        "xpack.set_nsis_displayicon",
        -- set package component title
        "xpack_component.set_title",
        -- set package component description
        "xpack_component.set_description",
        -- enable/disable this component by default
        "xpack_component.set_default"
    },
    paths = {
        -- set the spec file path, support the custom variable pattern, e.g. set_specfile("", {pattern = "%${([^\n]-)}"})
        "xpack.set_specfile",
        -- set icon file path, e.g foo.ico
        "xpack.set_iconfile",
        -- set package license file, we will also get them from target
        "xpack.set_licensefile",
        -- add source files
        "xpack.add_sourcefiles",
        -- add install files, we will also get them from target
        "xpack.add_installfiles",
        -- add source files for component
        "xpack_component.add_sourcefiles",
        -- add install files for component
        "xpack_component.add_installfiles"
    },
    script = {
        -- add custom load script
        "xpack.on_load",
        -- add custom package script before packing package
        "xpack.before_package",
        -- rewrite custom package script
        "xpack.on_package",
        -- add custom package script after packing package
        "xpack.after_package",
        -- add custom commands script before installing
        "xpack.before_installcmd",
        -- add custom commands script before uninstalling
        "xpack.before_uninstallcmd",
        -- rewrite custom install commands script, we will also get it from target/rules
        "xpack.on_installcmd",
        -- rewrite custom uninstall commands script, we will also get it from target/rules
        "xpack.on_uninstallcmd",
        -- add custom commands script after installing
        "xpack.after_installcmd",
        -- add custom commands script after uninstalling
        "xpack.after_uninstallcmd",
        -- add custom load script in component
        "xpack_component.on_load",
        -- add custom commands script before installing in component
        "xpack_component.before_installcmd",
        -- add custom commands script before uninstalling in component
        "xpack_component.before_uninstallcmd",
        -- rewrite custom install commands script in component, we will also get it from target/rules
        "xpack_component.on_installcmd",
        -- rewrite custom uninstall commands script in component, we will also get it from target/rules
        "xpack_component.on_uninstallcmd",
        -- add custom commands script after installing in component
        "xpack_component.after_installcmd",
        -- add custom commands script after uninstalling in component
        "xpack_component.after_uninstallcmd"
    },
    keyvalues = {
        -- set the spec variable
        "xpack.set_specvar"
    }
}

Example

https://github.com/xmake-io/xmake/blob/dev/tests/plugins/pack/xmake.lua

set_version("1.0.0")
add_rules("mode.debug", "mode.release")

includes("@builtin/xpack")

add_requires("zlib", {configs = {shared = true}})

target("test")
    set_kind("binary")
    add_files("src/*.cpp")
    if is_plat("windows") then
        add_files("src/*.rc")
    end

target("foo")
    set_kind("shared")
    add_files("src/*.cpp")
    add_headerfiles("include/(*.h)")
    add_packages("zlib")

xpack("test")
    set_formats("nsis", "zip", "targz", "srczip", "srctargz", "runself")
    set_title("hello")
    set_author("ruki")
    set_description("A test installer.")
    set_homepage("https://xmake.io")
    set_licensefile("LICENSE.md")
    add_targets("test", "foo")
    add_installfiles("src/(assets/*.png)", {prefixdir = "images"})
    add_sourcefiles("(src/**)")
    set_iconfile("src/assets/xmake.ico")
    add_components("LongPath")

    on_load(function (package)
        if package:from_source() then
            package:set("basename", "test-$(plat)-src-v$(version)")
        else
            package:set("basename", "test-$(plat)-$(arch)-v$(version)")
        end
    end)

    after_installcmd(function (package, batchcmds)
        if package:from_source() then
            batchcmds:runv("echo", {"hello"})
        else
            batchcmds:mkdir(package:installdir("resources"))
            batchcmds:cp("src/assets/*.txt", package:installdir("resources"), {rootdir = "src"})
            batchcmds:mkdir(package:installdir("stub"))
        end
    end)

    after_uninstallcmd(function (package, batchcmds)
        batchcmds:rmdir(package:installdir("resources"))
        batchcmds:rmdir(package:installdir("stub"))
    end)

xpack_component("LongPath")
    set_default(false)
    set_title("Enable Long Path")
    set_description("Increases the maximum path length limit, up to 32,767 characters (before 256).")
    on_installcmd(function (component, batchcmds)
        batchcmds:rawcmd("nsis", [[
  ${If} $NoAdmin == "false"
    ; Enable long path
    WriteRegDWORD ${HKLM} "SYSTEM\CurrentControlSet\Control\FileSystem" "LongPathsEnabled" 1
  ${EndIf}]])
    end)

Pack packages

$ xmake pack

waruqi · 2023-11-15T04:01:06Z

Pack NSIS package

It will download and install NSIS (makensis.exe) first automically.

$ xmake pack
note: install or modify (m) these packages (pass -y to skip confirm)?
in xmake-repo:
  -> nsis 3.09
please input: y (y/n/m)

  => install nsis 3.09 .. ok

[ 25%]: compiling.release src\main.cpp
[ 37%]: compiling.release src\main.cpp
[ 50%]: linking.release foo.dll
[ 62%]: linking.release test.exe
packing build\xpack\test\test-windows-x64-v1.0.0.exe
pack ok

waruqi · 2023-11-17T04:11:07Z

More example: Pack xmake installation package https://github.com/xmake-io/xmake/blob/dev/core/xpack.lua

waruqi · 2023-11-18T13:58:22Z

Support pack zip/tar.gz archive

xpack("test")
    set_formats("zip", "targz")

$ xmake pack
$ xmake pack --formats=zip,targz

waruqi · 2023-11-22T03:05:58Z

Support components and custom nsis commands

xpack("test")
    add_components("LongPath")

xpack_component("LongPath")
    set_default(false)
    set_title("Enable Long Path")
    set_description("Increases the maximum path length limit, up to 32,767 characters (before 256).")
    on_installcmd(function (component, batchcmds)
        batchcmds:rawcmd("nsis", [[
  ${If} $NoAdmin == "false"
    ; Enable long path
    WriteRegDWORD ${HKLM} "SYSTEM\CurrentControlSet\Control\FileSystem" "LongPathsEnabled" 1
  ${EndIf}]])
    end)

waruqi · 2023-11-24T15:24:51Z

Pack source zip/tar.gz package

xpack("test")
    set_formats("srczip", "srctargz")
    add_sourcefiles("(src/**)")

$ xmake pack
packing build/xpack/test/test-macosx-src-v1.0.0.zip ..
packing build/xpack/test/test-macosx-src-v1.0.0.tar.gz ..
pack ok

Pack runself package

xpack("test")
    set_formats("runself")
    add_sourcefiles("(src/**)")
    on_installcmd(function (package, batchcmds)
        batchcmds:runv("make", {"install"})
    end)

$ xmake pack
packing build/xpack/test/test-macosx-src-v1.0.0.gz.run
pack ok

$ sh ./build/xpack/test/test-macosx-src-v1.0.0.gz.run

xmake/core/xpack.lua

Lines 79 to 112 in 51efaa7

    
           xpack("xmakesrc") 
        
               set_formats("srczip", "srctargz", "runself") 
        
               set_basename("xmake-v$(version)") 
        
               set_prefixdir("xmake-$(version)") 
        
               before_package(function (package) 
        
                   import("devel.git") 
        
                   local rootdir = path.join(os.tmpfile(package:basename()) .. ".dir", "repo") 
        
                   if not os.isdir(rootdir) then 
        
                       os.tryrm(rootdir) 
        
                       os.cp(path.directory(os.projectdir()), rootdir) 
        
                       git.clean({repodir = rootdir, force = true, all = true}) 
        
                       git.reset({repodir = rootdir, hard = true}) 
        
                       if os.isfile(path.join(rootdir, ".gitmodules")) then 
        
                           git.submodule.clean({repodir = rootdir, force = true, all = true}) 
        
                           git.submodule.reset({repodir = rootdir, hard = true}) 
        
                       end 
        
                   end 
        
                   local extraconf = {rootdir = rootdir} 
        
                   package:add("sourcefiles", path.join(rootdir, "core/**|src/pdcurses/**|src/luajit/**|src/tbox/tbox/src/demo/**"), extraconf) 
        
                   package:add("sourcefiles", path.join(rootdir, "xmake/**"), extraconf) 
        
                   package:add("sourcefiles", path.join(rootdir, "*.md"), extraconf) 
        
                   package:add("sourcefiles", path.join(rootdir, "configure"), extraconf) 
        
                   package:add("sourcefiles", path.join(rootdir, "scripts/*.sh"), extraconf) 
        
                   package:add("sourcefiles", path.join(rootdir, "scripts/man/**"), extraconf) 
        
                   package:add("sourcefiles", path.join(rootdir, "scripts/debian/**"), extraconf) 
        
                   package:add("sourcefiles", path.join(rootdir, "scripts/msys/**"), extraconf) 
        
               end) 
        
               on_installcmd(function (package, batchcmds) 
        
                   batchcmds:runv("./scripts/get.sh", {"__local__"}) 
        
               end)

waruqi · 2023-12-21T09:36:50Z

Pack srpm package

Pack xmake project with targets

xpack("test")
    set_homepage("https://xmake.io")
    set_license("Apache-2.0")
    set_description("A cross-platform build utility based on Lua.")

    set_formats("srpm")
    add_sourcefiles("(src/**)")
    add_sourcefiles("./xmake.lua")

    add_targets("demo")

Pack 3rd build system project

xpack("test")
    set_homepage("https://xmake.io")
    set_license("Apache-2.0")
    set_description("A cross-platform build utility based on Lua.")

    set_formats("srpm")
    add_sourcefiles("(src/**)")
    add_sourcefiles("./configure")

    on_buildcmd(function (package, batchcmds)
        batchcmds:runv("./configure")
        batchcmds:runv("make")
    end)

    on_installcmd(function (package, batchcmds)
        batchcmds:runv("make", {"install", "PREFIX=%{buildroot}"})
    end)

waruqi · 2024-06-14T15:49:18Z

deb: #5210
wix: #5153

waruqi added the feature request label Jun 1, 2021

waruqi added this to the todo milestone Jun 1, 2021

waruqi added the contribution welcome label Jun 1, 2021

waruqi changed the title ~~Add xpack command to generate installation package like cmake/cpack~~ Add xmake pack command to generate installation package like cmake/cpack Jun 1, 2021

waruqi mentioned this issue Oct 29, 2023

switch build system? dosemu2/fdpp#146

Open

waruqi modified the milestones: todo, v2.8.6 Nov 8, 2023

waruqi mentioned this issue Nov 8, 2023

Support xmake pack #4373

Merged

waruqi mentioned this issue Nov 21, 2023

Support xpack components #4406

Merged

waruqi mentioned this issue Nov 23, 2023

pack runself #4415

Merged

waruqi mentioned this issue Dec 18, 2023

Support to pack srpm package #4515

Merged

waruqi mentioned this issue Dec 21, 2023

pack xmake install to srpm #4529

Merged

waruqi closed this as completed Dec 22, 2023

Freed-Wu mentioned this issue Apr 9, 2024

[FR] Please add option to build DEB/RPM packages mesonbuild/meson#12468

Open

waruqi mentioned this issue Oct 4, 2024

Explore alternate build systems CHERIoT-Platform/cheriot-rtos#304

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `xmake pack` command to generate installation package like cmake/cpack #1433

Add `xmake pack` command to generate installation package like cmake/cpack #1433

waruqi commented Jun 1, 2021 •

edited

Loading

waruqi commented Nov 15, 2023 •

edited

Loading

waruqi commented Nov 15, 2023

waruqi commented Nov 17, 2023

waruqi commented Nov 18, 2023 •

edited

Loading

waruqi commented Nov 22, 2023 •

edited

Loading

waruqi commented Nov 24, 2023 •

edited

Loading

waruqi commented Dec 21, 2023 •

edited

Loading

waruqi commented Jun 14, 2024

Add xmake pack command to generate installation package like cmake/cpack #1433

Add xmake pack command to generate installation package like cmake/cpack #1433

Comments

waruqi commented Jun 1, 2021 • edited Loading

Roadmaps

Refs

waruqi commented Nov 15, 2023 • edited Loading

New Scope Apis (xpack)

Example

Pack packages

waruqi commented Nov 15, 2023

Pack NSIS package

waruqi commented Nov 17, 2023

waruqi commented Nov 18, 2023 • edited Loading

Support pack zip/tar.gz archive

waruqi commented Nov 22, 2023 • edited Loading

Support components and custom nsis commands

waruqi commented Nov 24, 2023 • edited Loading

Pack source zip/tar.gz package

Pack runself package

waruqi commented Dec 21, 2023 • edited Loading

Pack srpm package

Pack xmake project with targets

Pack 3rd build system project

waruqi commented Jun 14, 2024

Add `xmake pack` command to generate installation package like cmake/cpack #1433

Add `xmake pack` command to generate installation package like cmake/cpack #1433

waruqi commented Jun 1, 2021 •

edited

Loading

waruqi commented Nov 15, 2023 •

edited

Loading

waruqi commented Nov 18, 2023 •

edited

Loading

waruqi commented Nov 22, 2023 •

edited

Loading

waruqi commented Nov 24, 2023 •

edited

Loading

waruqi commented Dec 21, 2023 •

edited

Loading