reubeno / brush

bash/POSIX-compatible shell implemented in Rust
MIT License
26 stars 4 forks source link

docs: generate usage docs in actions via xtask #249

Closed reubeno closed 3 weeks ago

reubeno commented 3 weeks ago

Generate and upload command-line usage docs (markdown, man) in actions.

github-actions[bot] commented 3 weeks ago

Performance Benchmark Report

Benchmark name Baseline (μs) Test/PR (μs) Delta (μs) Delta %
expand_one_string 3.41 μs 3.40 μs -0.00 μs ⚪ Unchanged
instantiate_shell 60.85 μs 60.94 μs 0.09 μs ⚪ Unchanged
instantiate_shell_with_init_scripts 30561.29 μs 30525.76 μs -35.53 μs ⚪ Unchanged
parse_bash_completion 2774.03 μs 2847.86 μs 73.83 μs 🟠 +2.66%
parse_sample_script 4.13 μs 4.34 μs 0.21 μs 🟠 +5.16%
run_echo_builtin_command 90.17 μs 89.31 μs -0.86 μs ⚪ Unchanged
run_one_builtin_command 109.00 μs 107.48 μs -1.53 μs ⚪ Unchanged
run_one_external_command 2031.12 μs 1924.58 μs -106.54 μs 🟢 -5.25%
run_one_external_command_directly 1008.00 μs 1008.74 μs 0.74 μs ⚪ Unchanged

Code Coverage Report: Only Changed Files listed

Package Base Coverage New Coverage Difference
brush-core/src/shell.rs 🟢 77.73% 🟢 77.87% 🟢 0.14%
Overall Coverage 🟢 73.79% 🟢 73.8% 🟢 0.01%

Minimum allowed coverage is 70%, this run produced 73.8%