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.

Sign up for GitHub

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

README: various updates #378

Merged
merged 3 commits into from
Nov 20, 2023
Merged

README: various updates #378

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1e5c2f1
drop nix-review note
Mic92 Nov 20, 2023
7ed3f72
README: update install instructions
Mic92 Nov 20, 2023
2b9d7f8
drop outdated comment about black
Mic92 Nov 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 3 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
Review pull-requests on https://github.com/NixOS/nixpkgs. nixpkgs-review
automatically builds packages changed in the pull requests.

NOTE: this project used to be called `nix-review`

## Features

- [ofborg](https://github.com/NixOS/ofborg) support: reuses evaluation output of
Expand All @@ -25,19 +23,12 @@ NOTE: this project used to be called `nix-review`

## Installation

`nixpkgs-review` is included in nixpkgs. Older versions of nixpkgs might still
call it `nix-review`.
`nixpkgs-review` is included in nixpkgs.

To use it without installing it, use:

```console
$ nix run nixpkgs#nixpkgs-review
```

To install it:

```console
$ nix-env -f '<nixpkgs>' -iA nixpkgs-review
$ nix run 'nixpkgs#nixpkgs-review'
```

To run it from the git repository:
Expand All @@ -47,15 +38,6 @@ $ nix-build
$ ./result/bin/nixpkgs-review
```

Note that this asserts formatting with the latest version of
[black](https://github.com/psf/black), so you may need to specify a more up to
date version of nixpkgs:

```console
$ nix-build -I nixpkgs=https://github.com/NixOS/nixpkgs-channels/archive/nixpkgs-unstable.tar.gz
$ ./result/bin/nixpkgs-review
```

### Development Environment

For IDEs:
Expand Down Expand Up @@ -225,7 +207,7 @@ corresponding pull request URL is shown.

## Remote builder

Nix-review will pass all arguments given in `--build-arg` to `nix-build`:
Nixpkgs-review will pass all arguments given in `--build-arg` to `nix-build`:

```console
$ nixpkgs-review pr --build-args="--builders 'ssh://[email protected]'" 37244
Expand Down