c4patino/nixpkgs-review-gha
1
0
Fork 0
Code Issues Projects Releases Packages Wiki Activity
Run nixpkgs-review in GitHub Actions
13 commits 1 branch 0 tags 238 KiB
  • JavaScript 75.8%
  • Nix 24.2%
Find a file
Defelo 9fbb1a14c6
 fix: set fail-fast to false
2025-01-29 22:40:01 +01:00
.github/workflows fix: set fail-fast to false 2025-01-29 22:40:01 +01:00
LICENSE init 2025-01-25 20:10:01 +01:00
README.md feat: add shortcut.js 2025-01-27 22:57:30 +01:00
shortcut.js feat: add shortcut.js 2025-01-27 22:57:30 +01: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
  • Wait for upstream evaluation to finish before running nixpkgs-review
  • Optionally start a tmate session after nixpkgs-review has finished to allow interactive testing/debugging via SSH
  • Push new packages to an attic cache
  • 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, 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 it's 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 it's value to the token you generated before.
  5. (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.

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