Skip to content
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

docs: add how to use via nixpkgs #387

Merged
merged 2 commits into from
Feb 20, 2025

Conversation

kachick
Copy link
Contributor

@kachick kachick commented Feb 20, 2025

I have added the package definition in NixOS/nixpkgs#382795.
I hope this will make it easy to use by visitors without the build step. A binary cache of Nix might be an alternative solution for #69.

@reubeno
Copy link
Owner

reubeno commented Feb 20, 2025

Thanks for your contribution, @kachick, and for adding the nix package definition! I like the idea of mentioning it in README.md.

I'll review the proposed changes shortly.

README.md Outdated
@@ -46,6 +46,14 @@ If you don't have `rust` installed, we recommend installing it via [`rustup`](ht
(If you *are* interested in having a binary release, then please let us know in the 'Discussions' area of this
project or by filing a feature request in 'Issues'.)

[![Packaging status](https://repology.org/badge/vertical-allrepos/brush.svg)](https://repology.org/project/brush/versions)
Copy link
Owner

Choose a reason for hiding this comment

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

I'm a fan of repology; would be great to include the badge. Could you move the badge up with the rest of the badges near the top of the README? That will fit in well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure! I have moved it with adding a blank line to fix mismatch of different badge height.

9345e82

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the link for other styles of badges we can choose. https://repology.org/project/brush/badges

Packaging status

Packaging status

latest packaged version(s)

nixpkgs unstable package

Copy link
Owner

Choose a reason for hiding this comment

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

Thanks for the info; the current badge looks fine for now.

@reubeno reubeno added the documentation Improvements or additions to documentation label Feb 20, 2025
Copy link

Performance Benchmark Report

Benchmark name Baseline (μs) Test/PR (μs) Delta (μs) Delta %
clone_shell_object 18.40 μs 17.91 μs -0.49 μs 🟢 -2.69%
eval_arithmetic 0.17 μs 0.17 μs -0.00 μs ⚪ Unchanged
expand_one_string 1.82 μs 1.97 μs 0.15 μs ⚪ Unchanged
for_loop 22.08 μs 22.05 μs -0.03 μs ⚪ Unchanged
function_call 2.47 μs 2.80 μs 0.33 μs ⚪ Unchanged
instantiate_shell 57.00 μs 56.75 μs -0.25 μs ⚪ Unchanged
instantiate_shell_with_init_scripts 22496.56 μs 23190.54 μs 693.98 μs ⚪ Unchanged
parse_bash_completion 1678.78 μs 1685.56 μs 6.77 μs ⚪ Unchanged
parse_sample_script 1.74 μs 1.75 μs 0.00 μs ⚪ Unchanged
run_echo_builtin_command 15.46 μs 15.46 μs 0.00 μs ⚪ Unchanged
run_one_external_command 2073.36 μs 2432.77 μs 359.41 μs 🟠 +17.33%
tokenize_sample_script 2.82 μs 2.86 μs 0.03 μs ⚪ Unchanged

Code Coverage Report: Only Changed Files listed

Package Base Coverage New Coverage Difference
Overall Coverage 🟢 78.27% 🟢 78.27% ⚪ 0%

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

Test Summary: bash-completion test suite

Outcome Count Percentage
✅ Pass 1336 63.62
❗️ Error 234 11.14
❌ Fail 159 7.57
⏩ Skip 356 16.95
❎ Expected Fail 14 0.67
✔️ Unexpected Pass 1 0.05
📊 Total 2100 100.00

@reubeno reubeno merged commit bc4cc86 into reubeno:main Feb 20, 2025
18 checks passed
@reubeno
Copy link
Owner

reubeno commented Feb 20, 2025

Merged.

Thanks for making this change and for pursuing brush's packaging. Please don't hesitate to reach out again with any input or feedback you receive from the nix community!

@kachick
Copy link
Contributor Author

kachick commented Feb 20, 2025

Thank you for beginning this project!

@kachick kachick deleted the docs-installation-via-nixpkgs branch February 20, 2025 23:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants