c4patino/nixpkgs-review-gha
1
0
Fork 0
Code Issues Projects Releases Packages Wiki Activity
Run nixpkgs-review in GitHub Actions
39 commits 1 branch 0 tags 238 KiB
  • JavaScript 75.8%
  • Nix 24.2%
Find a file
Michael Daniels b6527ea29d
 fix: use nixpkgs-unstable instead of nixos-unstable 
As of 23:30 UTC, 2025-06-22, it seems that `nix` does not build on macOS on the
nixos-unstable channel. So the difference matters, at least on occasion.
2025-06-23 16:11:15 -04:00
.github/workflows fix: use nixpkgs-unstable instead of nixos-unstable 2025-06-23 16:11:15 -04:00
LICENSE init 2025-01-25 20:10:01 +01:00
README.md docs: add hint to update repo constant in shortcut script 2025-06-20 01:58:06 +02:00
shortcut.js feat(shortcut): add support for multiple pr trackers 2025-06-20 13:09:07 +02:00

README.md

nixpkgs-review-gha

Run nixpkgs-review in GitHub Actions

Features

  • Build on x86_64-linux, aarch64-linux, x86_64-darwin and aarch64-darwin
  • No local setup
  • Automatically post results on the reviewed pull request
  • Optionally start an Upterm session after nixpkgs-review has finished to allow interactive testing/debugging via SSH
  • Push new packages to an Attic or Cachix cache
  • Automatically approve pull requests on review success
  • Add a "Run nixpkgs-review" shortcut to pull request pages in nixpkgs

Setup

  1. Fork this repository.
  2. In your fork, go to the Actions tab and enable GitHub Actions workflows.
  3. (optional) If you want nixpkgs-review-gha to automatically post the results on the reviewed pull requests or automatically approve them, you need to generate a personal access token:
    1. Go to https://github.com/settings/tokens and generate a new classic token with the public_repo scope.
    2. In your fork, go to "Settings" > "Secrets and variables" > "actions" and add a new repository secret with the name GH_TOKEN and set its value to the personal access token you generated before.
  4. (optional) Follow these steps if you want nixpkgs-review-gha to push new packages to an Attic cache. Replace $CACHE with the name of your cache (e.g. nixpkgs) and $SERVER with the url of your Attic server (e.g. https://attic.example.com/):
    1. Generate a token with push and pull permissions: atticadm make-token --sub nixpkgs-review-gha --validity 1y --pull $CACHE --push $CACHE
    2. Create a new variable with the name ATTIC_SERVER and set it to the value of $SERVER
    3. Create a new variable with the name ATTIC_CACHE and set it to the value of $CACHE
    4. Create a new secret with the name ATTIC_TOKEN and set its value to the token you generated before.
  5. (optional) Follow these steps if you want nixpkgs-review-gha to push new packages to a Cachix cache. Note: If both an Attic cache and a Cachix cache is configured, the Attic cache is preferred and the Cachix configuration is ignored.
    1. Go to https://app.cachix.org/ and set up your binary cache.
    2. Create a new variable with the name CACHIX_CACHE and set it to the name of your Cachix cache.
    3. Create a new secret with the name CACHIX_AUTH_TOKEN and set its value to your auth token. If you are using a self-signed cache, you also need to create a CACHIX_SIGNING_KEY secret and set its value to your private signing key.
  6. (optional) Add shortcut.js as a user script in your browser for https://github.com/ for example using the User JavaScript and CSS chrome extension or Violentmonkey. Don't forget to update the repo constant at the top of the file to point to your fork.

Usage

  1. Open the review workflow in the "Actions" tab
  2. Click on "Run workflow"
  3. Enter the number of the pull request in nixpkgs you would like to review and click on "Run workflow"
  4. Reload the page if necessary and click on the review run to see the logs