summaryrefslogtreecommitdiff
path: root/doc/languages-frameworks
diff options
context:
space:
mode:
authorVictor Engmark <victor@engmark.name>2025-09-17 15:11:01 +0200
committerVictor Engmark <victor@engmark.name>2025-09-18 13:58:53 +0200
commit82c23622c7232f8b57924d6d4ab59a6089b88d55 (patch)
tree2ffc3716c523c79c4c0e4c1be908e6d56ded8072 /doc/languages-frameworks
parentpython3Packages.session-info2: 0.2.1 -> 0.2.2 (#442942) (diff)
downloadnixpkgs-82c23622c7232f8b57924d6d4ab59a6089b88d55.tar.gz
rubyPackages: Add command to audit packages
For known security vulnerabilities. Converts `pkgs/top-level/ruby-packages.nix` to a minimal `Gemfile.lock` for `bundler-audit`.
Diffstat (limited to 'doc/languages-frameworks')
-rw-r--r--doc/languages-frameworks/ruby.section.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/languages-frameworks/ruby.section.md b/doc/languages-frameworks/ruby.section.md
index 25c31de17e71..f1be5e04dd48 100644
--- a/doc/languages-frameworks/ruby.section.md
+++ b/doc/languages-frameworks/ruby.section.md
@@ -273,6 +273,8 @@ To test that it works, you can then try using the gem with:
NIX_PATH=nixpkgs=$PWD nix-shell -p "ruby.withPackages (ps: with ps; [ name-of-your-gem ])"
```
+To check the gems for any security vulnerabilities, run `./maintainers/scripts/audit-ruby-packages/audit-ruby-packages.bash`.
+
### Packaging applications {#packaging-applications}
A common task is to add a Ruby executable to Nixpkgs; popular examples would be `chef`, `jekyll`, or `sass`. A good way to do that is to use the `bundlerApp` function, that allows you to make a package that only exposes the listed executables. Otherwise, the package may cause conflicts through common paths like `bin/rake` or `bin/bundler` that aren't meant to be used.