docs: added details around build, test, app_root to BUILDING.md - #2288
Open
michaelzhang114 wants to merge 1 commit into
Open
michaelzhang114 wants to merge 1 commit into
michaelzhang114 wants to merge 1 commit into
Conversation
github-actions
Bot
added
the
documentation
noah-thor
reviewed
Sep 18, 2026
| | `make install` | Builds an installer package and installs it to `/usr/local`. | | ||
| | `make clean` | Removes `bin/`, `libexec/`, generated docs, and coverage output. | | ||
|
|
||
| `make integration` runs the `container` CLI from `bin/`, so build the binaries with `make all` first, either as a separate command or in the same invocation as shown above. |
Contributor
There was a problem hiding this comment.
Should we modify the makefile to make this dependency explicit in the targets?
|
|
||
| How `make integration` treats `APP_ROOT`: | ||
| - It erases the directory's contents before each run. | ||
| - If you leave `APP_ROOT` unset, the integration tests run against your default data directory. They will not erase it, but they will create and delete containers in it. Always set `APP_ROOT` when running the integration tests. |
Contributor
There was a problem hiding this comment.
I think we can omit "Always set APP_ROOT when running the integration tests." as we might want to ensure "real-ish" behavior sometimes, like for qualification. Or should we have APP_ROOT default to an in-repo tmp like folder?
Comment on lines
+102
to
+110
| ./bin/container system stop | ||
| container system stop | ||
| scripts/ensure-container-stopped.sh -a | ||
|
|
||
| # 2. Remove build outputs | ||
| make clean | ||
|
|
||
| # 3. Remove the scratch app root | ||
| rm -rf test-data |
Contributor
There was a problem hiding this comment.
Should we make a make target for this to simplify the UX? If we have a default APP_ROOT for make then we could potentially make it one simple target
Code Coverage
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Important
All commits must be signed and verified. Pull requests containing unsigned or unverified commits cannot be built or merged. See the GitHub documentation for instructions.
For all but trivial fixes, make sure to first create a GitHub issue that concisely describes the bug or desired enhancement as justification for the change. Large PRs with no justifying issue will be closed.
Type of Change
Motivation and Context
Fixes #2287
A new contributor following the documented command can stop their working
containerinstallation with no warning, and has no way to know which knobs exist without reading the
Makefile.
Testing