Introduce new command, xtask print #905
Merged
Conversation
This file contains 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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
license-eye has totally checked 391 files.
| Valid | Invalid | Ignored | Fixed |
|---|---|---|---|
| 390 | 1 | 0 | 0 |
Click to see the invalid file list
- build/xtask/src/print.rs
steveklabnik
force-pushed
the
print-archive-path
branch
from
82e6a1e
to
79b18a5
Compare
steveklabnik
commented
Nov 2, 2022
|
|
||
| println!("{}", final_path.display()); | ||
| } else { | ||
| bail!("I'm not sure what to print. Currently supported: --archive"); |
There was a problem hiding this comment.
I'd prefer to use an ArgGroup here, but it seems like it's not fully baked in the derive API yet clap-rs/clap#2621
No big deal.
| .ok_or(Error::msg(format!("cannot find image {}", image_name)))?; | ||
|
|
||
| let final_path = config | ||
| .img_file(format!("build-{}.zip", config.toml.name), image_name); |
There was a problem hiding this comment.
I am a little not happy about this one, as it's duplicating the logic that's already been duplicated twice:
hubris/build/xtask/src/humility.rs
Line 29 in 0b29eb5
hubris/build/xtask/src/dist.rs
Line 579 in 60ecfe3
Not 100% sure what the best way to solve this would be, though...
mkeeter
approved these changes
Nov 2, 2022
steveklabnik
force-pushed
the
print-archive-path
branch
from
632d9d6
to
6c8de73
Compare
steveklabnik
force-pushed
the
print-archive-path
branch
from
6c8de73
to
ac9c52a
Compare
This command can print out information about the build. Currently, it
only supports one option, --archive, which prints out the final build
archive. This is useful in scripting.
Example:
```
〉cargo xtask print .\app\demo-stm32f4-discovery\app.toml --archive
Finished dev [optimized + debuginfo] target(s) in 1.68s
Running `target\debug\xtask.exe print .\app\demo-stm32f4-discovery\app.toml --archive`
target\demo-stm32f4-discovery\dist\default\build-demo-stm32f4-discovery.zip
```
Additonally, I wanted to make the errors nice for this, and so I ended
up adding some contexts inside of the other commands, which will also
make them slightly better. Example:
```
〉cargo xtask print .\app\demo-stm32f4-discovery\app.tom --archive
Finished dev [optimized + debuginfo] target(s) in 1.52s
Running `target\debug\xtask.exe print .\app\demo-stm32f4-discovery\app.tom --archive`
Error: could not print information about the build
Caused by:
0: could not create build configuration
1: could not read .\app\demo-stm32f4-discovery\app.tom
2: The system cannot find the file specified. (os error 2)
```
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
steveklabnik
force-pushed
the
print-archive-path
branch
from
ac9c52a
to
f851223
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This command can print out information about the build. Currently, it only supports one option, --archive, which prints out the final build archive. This is useful in scripting.
Example:
Additonally, I wanted to make the errors nice for this, and so I ended up adding some contexts inside of the other commands, which will also make them slightly better. Example:
This feature was requested by @rmustacc and @jclulow , so I'd love to make sure that this satisfies their needs.
I could make the command just
print-archive(suggested by @mkeeter) and remove some of the machinery here, but I feel like we've wanted to print other stuff in the past? IIRC @cbiffle was talking about something with environment variables? maybe that was just setting them, not examining them.