Skip to content

Latest commit

 

History

History
69 lines (57 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

69 lines (57 loc) · 2.2 KB
Raw

Contributor documentation

@infinisil is the admin and main developer of this repository, while everybody in @NixOS/nixpkgs-check-by-name has write access.

Development

Enter the development environment in this directory either automatically with direnv or manually with

nix-shell

The most important tools and commands in this environment are:

  • rust-analyzer to have an IDE-like experience for your own editor.
  • Running tests: 
    cargo test
  • Linting and formatting: 
    cargo clippy --all-targets
treefmt
  • Running the main CI checks locally: 
    nix-build -A ci

Integration tests

Integration tests are declared in ./tests as subdirectories imitating Nixpkgs with these files:

  • default.nix: Always contains

    import <test-nixpkgs> { root = ./.; }

    which makes

    nix-instantiate <subdir> --eval -A <attr> --arg overlays <overlays>

    work very similarly to the real Nixpkgs, just enough for the program to be able to test it.

  • pkgs/by-name: The pkgs/by-name directory to check.

  • pkgs/top-level/all-packages.nix (optional): Contains an overlay of the form

    self: super: {
  # ...
}

    allowing the simulation of package overrides to the real pkgs/top-level/all-packages.nix. The default is an empty overlay.

  • base (optional): Contains another subdirectory imitating Nixpkgs with potentially any of the above structures. This is used to test ratchet checks.

  • expected (optional): A file containing the expected standard output. The default is expecting an empty standard output.

Automation

Pinned dependencies are regularly updated automatically.

Releases are automatically created when the version field in Cargo.toml is updated from a push to the main branch.