Giter VIP home page Giter VIP logo

bombon's Introduction

Bombon

Automagically build CycloneDX Software Bills of Materials (SBOMs) for Nix packages!

Getting Started

Flakes

nix flake init -t github:nikstur/bombon

Or manually copy this to flake.nix in your repository:

# file: flake.nix
{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
    bombon.url = "github:nikstur/bombon";
    bombon.inputs.nixpkgs.follows = "nixpkgs";
  };

  outputs = { self, nixpkgs, bombon }:
    let
      system = "x86_64-linux";
      pkgs = import nixpkgs { inherit system; };
    in
    {
      packages.${system}.default = bombon.lib.${system}.buildBom pkgs.hello { };
    };
}

Niv

niv init
niv add nikstur/bombon
# file: default.nix
let
  sources = import ./nix/sources.nix { };
  pkgs = import sources.nixpkgs { };
  bombon = import sources.bombon;
  system = "x86_64-linux";
in
bombon.lib.${system}.buildBom pkgs.hello { }

Options

buildBom accepts options as an attribute set. All attributes are optional:

  • includeBuildtimeDependencies: boolean flag to include buildtime dependencies in output.

Example:

bombon.lib.${system}.buildBom pkgs.hello {
  includeBuildtimeDependencies = true;
}

Contributing

During development, the Nix Repl is a convenient and quick way to test changes. Start the repl, loading your local version of nixpkgs.

nix repl <nixpkgs>

Inside the repl, load the bombon flake and build the BOM for a package you are interested in.

:l .
:b lib.x86_64-linux.buildBom python3 { }

Remember to re load the bombon flake every time you made changes to any of the source code.

Acknowledgements

The way dependencies are retrieved using Nix is heavily influenced by this blog article from Nicolas Mattia.

bombon's People

Contributors

nikstur avatar renovate[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.