-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add heph validate guide and update CI guide #46
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| title: "Validating your workspace" | ||
| sidebar_position: 3 | ||
| description: Use heph validate to catch broken targets, overlapping codegen outputs, and a stale .gitignore before they reach CI. | ||
| --- | ||
|
|
||
| # Validating your workspace | ||
|
|
||
| `heph validate` checks your workspace without running any builds. It resolves every target's inputs, detects overlapping codegen outputs, and verifies that `.gitignore` is current. All three checks run in parallel and every failure is reported at once — not just the first one — so you can fix everything in a single pass. | ||
|
|
||
| ## What it checks | ||
|
|
||
| | Check | What it catches | | ||
| |-------|-----------------| | ||
| | **Target link** | Every in-scope target is parsed and its runtime inputs are resolved. A missing dependency or an unresolvable target surfaces here. No execution happens. | | ||
| | **Codegen overlap** | Two `codegen = copy` targets that write to the same output path. | | ||
| | **`.gitignore` freshness** | The `.gitignore` block maintained by heph is out of date. If stale, the error message tells you to run `heph tool gen-gitignore`. Skipped when a package matcher is provided. | | ||
|
|
||
| ## Usage | ||
|
|
||
| ```bash title="terminal" | ||
| heph validate # whole workspace | ||
| heph validate //pkg/... # scope to a package matcher | ||
| ``` | ||
|
|
||
| When a package matcher is provided, the `.gitignore` freshness check is skipped (it applies to the whole workspace), and a warning is printed to say so. The target link and overlap checks still run. | ||
|
|
||
| If any check fails, `heph validate` exits non-zero and lists every problem it found. | ||
|
|
||
| ## In CI | ||
|
|
||
| `heph validate` is a natural CI gate: it is read-only, exits non-zero on any problem, and surfaces all failures in one run. | ||
|
|
||
| ```bash title="terminal" | ||
| heph validate | ||
| ``` | ||
|
|
||
| See [Using heph in CI](/docs/guides/ci) for a representative CI job. |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove all the --no-tui flags