Skip to content

Generate Zig metadata before final build #2867

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
plajjan wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Generate Zig metadata before final build #2867

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49b6f28
Generate Zig metadata before final build
Jun 3, 2026
dc96ddd
Keep root build.zig generation quiet
Jun 4, 2026
c4741bb
Skip final Zig build in metadata tests
Jun 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 12 additions & 18 deletions compiler/acton/Main.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1993,7 +1993,8 @@ runCliPostCompile cliHooks gopts plan env = do
rootModuleEntries = excludeLibrarySources rootBuildLibraries rootSelectedModuleEntries
rootDepModuleOpts = M.findWithDefault M.empty rootProj depModuleOptsByProj
rootDepPathOverrides = projectDepPathOverrides projMap rootProj
-- Generate build.zig(.zon) for dependencies too, to satisfy Zig builder links.
-- Generate build.zig(.zon) before the final Zig build so --skip-build keeps
-- build metadata up to date while still skipping stubs, pruning, and Zig.
let projKeys = Data.Set.fromList (map (tkProj . gtKey) globalTasks)
forM_ (Data.Set.toList projKeys) $ \p -> do
let isRootProj = p == rootProj
Expand All @@ -2008,6 +2009,9 @@ runCliPostCompile cliHooks gopts plan env = do
depPathOverrides = projectDepPathOverrides projMap p
genBuildZigFiles (projBuildSpec pctx) rootPins (ccDepOverrides cctx) dummyPaths depOpts depPathOverrides
Nothing -> return ()
let isRootSysProj = rootProj == sysAbs || sysRoot `isPrefixOf` rootProj
unless isRootSysProj $
genBuildZigFiles rootSpec rootPins (ccDepOverrides cctx) pathsRoot rootDepModuleOpts rootDepPathOverrides
Comment on lines +2013 to +2014
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot Jun 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Guard root metadata writes in alt-output modes

When acton build is run with an alternate output flag such as --sigs, --parse, or --cgen, the existing final build path is still skipped by the later unless (altOutput opts'), so these commands are intended to dump analysis/codegen output without touching the root Zig project files. This unconditional root genBuildZigFiles call now overwrites build.zig and build.zig.zon even in those modes; please keep it under the same non-altOutput condition (while still allowing --skip-build) so inspection commands do not mutate project metadata.

Useful? React with 👍 / 👎.

let runFinal action = do
cchFinalStart cliHooks
mtime <- action `onException` cchFinalDone cliHooks Nothing
Expand All @@ -2020,10 +2024,10 @@ runCliPostCompile cliHooks gopts plan env = do
then do
testBinTasks <- catMaybes <$> mapM (filterMainActor env pathsRoot) preTestBinTasks
unless (altOutput opts') $
runFinal (compileBins gopts opts' pathsRoot env rootSpec rootTasks testBinTasks allowPrune' rootModuleEntries rootBuildLibraries rootDepModuleOpts rootDepPathOverrides (Just (cchProgressUI cliHooks)))
runFinal (compileBins gopts opts' pathsRoot env rootTasks testBinTasks allowPrune' rootModuleEntries rootBuildLibraries (Just (cchProgressUI cliHooks)))
else do
unless (altOutput opts') $
runFinal (compileBins gopts opts' pathsRoot env rootSpec rootTasks preBinTasks allowPrune' rootModuleEntries rootBuildLibraries rootDepModuleOpts rootDepPathOverrides (Just (cchProgressUI cliHooks)))
runFinal (compileBins gopts opts' pathsRoot env rootTasks preBinTasks allowPrune' rootModuleEntries rootBuildLibraries (Just (cchProgressUI cliHooks)))
-- Generate documentation index for a project build by reading module names and
-- docstrings from cached .tydb headers or source headers.
generateProjectDocIndex :: Source.SourceProvider -> C.GlobalOptions -> C.CompileOptions -> Paths -> [String] -> IO ()
Expand Down Expand Up @@ -2288,9 +2292,9 @@ High-level Steps
================================================================================
-}

compileBins:: C.GlobalOptions -> C.CompileOptions -> Paths -> Acton.Env.Env0 -> BuildSpec.BuildSpec -> [CompileTask] -> [BinTask] -> Bool -> [FilePath] -> [BuildLibrary] -> M.Map String String -> M.Map String FilePath -> Maybe ProgressUI -> IO TimeSpec
compileBins gopts opts paths env rootSpec tasks binTasks allowPrune rootModules buildLibraries depModuleOpts depPathOverrides mProgressUI =
zigBuild env gopts opts paths rootSpec tasks binTasks allowPrune rootModules buildLibraries depModuleOpts depPathOverrides mProgressUI
compileBins:: C.GlobalOptions -> C.CompileOptions -> Paths -> Acton.Env.Env0 -> [CompileTask] -> [BinTask] -> Bool -> [FilePath] -> [BuildLibrary] -> Maybe ProgressUI -> IO TimeSpec
compileBins gopts opts paths env tasks binTasks allowPrune rootModules buildLibraries mProgressUI =
zigBuild env gopts opts paths tasks binTasks allowPrune rootModules buildLibraries mProgressUI

printDiag :: C.GlobalOptions -> C.CompileOptions -> Diagnostic String -> IO ()
printDiag gopts opts d = do
Expand Down Expand Up @@ -2703,8 +2707,8 @@ defCpuFlag = ["-Dcpu=x86_64_v2+aes"]
#endif

-- | Run zig build for generated artifacts and prune stale outputs.
zigBuild :: Acton.Env.Env0 -> C.GlobalOptions -> C.CompileOptions -> Paths -> BuildSpec.BuildSpec -> [CompileTask] -> [BinTask] -> Bool -> [FilePath] -> [BuildLibrary] -> M.Map String String -> M.Map String FilePath -> Maybe ProgressUI -> IO TimeSpec
zigBuild env gopts opts paths rootSpec tasks binTasks allowPrune rootModules buildLibraries depModuleOpts depPathOverrides mProgressUI = do
zigBuild :: Acton.Env.Env0 -> C.GlobalOptions -> C.CompileOptions -> Paths -> [CompileTask] -> [BinTask] -> Bool -> [FilePath] -> [BuildLibrary] -> Maybe ProgressUI -> IO TimeSpec
zigBuild env gopts opts paths tasks binTasks allowPrune rootModules buildLibraries mProgressUI = do
allBinTasks <- mapM (writeRootC env gopts opts paths tasks) binTasks
let realBinTasks = catMaybes allBinTasks

Expand All @@ -2727,16 +2731,6 @@ zigBuild env gopts opts paths rootSpec tasks binTasks allowPrune rootModules bui
let local_cache_dir = joinPath [ homeDir, ".cache", "acton", "zig-local-cache" ]
global_cache_dir = joinPath [ homeDir, ".cache", "acton", "zig-global-cache" ]
no_threads = if isWindowsOS (C.target opts) then True else C.no_threads opts
projAbs <- normalizePathSafe (projPath paths)
sysAbs <- normalizePathSafe (sysPath paths)
depOverrides <- normalizeDepOverrides (projPath paths) (C.dep_overrides opts)
let sysRoot = addTrailingPathSeparator sysAbs
isSysProj = projAbs == sysAbs || sysRoot `isPrefixOf` projAbs

-- Generate build.zig and build.zig.zon directly from Build.act.
iff (not isSysProj) $ do
let pins = BuildSpec.dependencies rootSpec
genBuildZigFiles rootSpec pins depOverrides paths depModuleOpts depPathOverrides

let zigExe = zig paths
baseArgs = ["build","--cache-dir", local_cache_dir,
Expand Down
16 changes: 8 additions & 8 deletions compiler/acton/test.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -712,7 +712,7 @@ compilerTests =
, "zig_dependencies = {}"
]
runBuild dir = readCreateProcessWithExitCode
(proc actonExe ["build", "--always-build"]) { cwd = Just dir, env = Just envWithHome } ""
(proc actonExe ["build", "--always-build", "--skip-build"]) { cwd = Just dir, env = Just envWithHome } ""

createDirectoryIfMissing True homeDir

Expand Down Expand Up @@ -857,7 +857,7 @@ compilerTests =
, " print(\"Hello, world\")"
, " env.exit(0)"
]
runActon "build" ExitSuccess False proj
runActon "build --skip-build" ExitSuccess False proj
zon <- readFile (proj </> "build.zig.zon")
let nameVal =
let isNameLine l = ".name = ." `isPrefixOf` dropWhile isSpace l
Expand Down Expand Up @@ -1449,9 +1449,9 @@ actonProjTests =
writeFile (zigProj </> "src" </> "root.zig") $ unlines
[ "pub export fn lmdb_test() void {}"
]
(returnCode, _cmdOut, cmdErr) <- readCreateProcessWithExitCode (proc actonExe ["build"]){ cwd = Just rootProj } ""
assertEqual "acton should build when package and zig deps share a name" ExitSuccess returnCode
assertBool "acton should not report the old dependency option collision" (not ("invalid option: -Dacton_modules" `isInfixOf` cmdErr))
(returnCode, _cmdOut, _cmdErr) <- readCreateProcessWithExitCode
(proc actonExe ["build", "--always-build", "--skip-build"]){ cwd = Just rootProj } ""
assertEqual "acton should generate metadata when package and zig deps share a name" ExitSuccess returnCode
rootZon <- readFile (rootProj </> "build.zig.zon")
rootBuildZig <- readFile (rootProj </> "build.zig")
assertBool "root build.zig.zon should keep the package dep key" (" .lmdb = .{" `isInfixOf` rootZon)
Expand Down Expand Up @@ -1549,9 +1549,9 @@ actonProjTests =
writeWrapper depCProj "dep_c" "../zig_other" "dep_c"
writeZigPkg zigCommonProj
writeZigPkg zigOtherProj
(returnCode, _cmdOut, cmdErr) <- readCreateProcessWithExitCode (proc actonExe ["build"]){ cwd = Just rootProj } ""
assertEqual "acton should build with colliding transitive zig dep names" ExitSuccess returnCode
assertBool "acton should not report the old dependency option collision" (not ("invalid option: -Dacton_modules" `isInfixOf` cmdErr))
(returnCode, _cmdOut, _cmdErr) <- readCreateProcessWithExitCode
(proc actonExe ["build", "--always-build", "--skip-build"]){ cwd = Just rootProj } ""
assertEqual "acton should generate metadata with colliding transitive zig dep names" ExitSuccess returnCode
rootZon <- readFile (rootProj </> "build.zig.zon")
rootBuildZig <- readFile (rootProj </> "build.zig")
assertBool "root build.zig.zon should include the first local zig dep name"
Expand Down
Loading