Run any command you like in a deterministic Nix shell on Linux and macOS.
Create .github/workflows/test.yml in your repo with the following contents:
name: "Test"
on:
pull_request:
push:
jobs:
tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: cachix/install-nix-action@v18
with:
nix_path: nixpkgs=channel:nixos-unstable
- uses: workflow/nix-shell-action@v3
with:
packages: hello,docker
script: |
hello
docker --helpYou can also pass in environment variables:
- uses: workflow/nix-shell-action@v3
env:
TRANSFORMER: bumblecat
with:
packages: hello,docker
script: |
hello $TRANSFORMER
docker --helpFor now, this action implicitly depends on having Nix installed and set up correctly, such as through the install-nix-action demonstrated in the examples above.
See also cachix-action for a simple binary cache setup to speed up your builds and share binaries with developers.
Instead of specifying packages, you can use flakes to specify fully qualified flakes to be available in your script.
This can be used for both local flakes in a flake.nix in your repo, as well as external flakes.
name: "Test"
on:
pull_request:
push:
jobs:
tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install Nix
uses: cachix/install-nix-action@v18
with:
extra_nix_config: |
access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
- uses: workflow/nix-shell-action@v3
with:
flakes: .#hello,nixpkgs#docker
script: |
# Runs hello from a local flake.nix
hello
# Uses docker from the nixpkgs registry (see https://raw.githubusercontent.com/NixOS/flake-registry/master/flake-registry.json)
command -v dockerInstead of specifying flakes, you can also tell this action to re-use the buildInputs from your devShell defined in a flake.nix, and automatically make these available to the script:
name: "Test with Flakes from DevShell"
on:
pull_request:
push:
jobs:
tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install Nix
uses: cachix/install-nix-action@v18
with:
extra_nix_config: |
access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
- uses: workflow/nix-shell-action@v3
with:
flakes-from-devshell: true
script: |
# Runs hello from a local flake.nix with a `devShell`
hello-
interpreter: Interpreter to use in the nix shell shebang, defaults tobash. (This is passed tonix run -c, used to be-iin a nix shell shebang) -
packages: Comma-separated list of packages to pre-install in your shell. Cannot be used together with theflakesoption. -
flakes: Comma-separated list of fully qualified flakes to pre-install in your shell. Use eitherpackagesorflakes. Cannot be used together with thepackagesoption. -
flakes-from-devshell: If true, supply flakes from adevShellprovided in your repo'sflake.nix. You cannot currently combined this with theflakesnorpackagesoptions. -
script: The actual script to execute in your shell. Will be passed to theinterpreter, which defaults tobash -
working-directory: Execute the script inside the specified working directory instead of the repository root. Example:path/to/dir
name: "Test"
on:
pull_request:
push:
jobs:
tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: cachix/install-nix-action@v18
with:
nix_path: nixpkgs=channel:nixos-unstable
extra_nix_config: |
access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
- uses: workflow/nix-shell-action@v3
with:
packages: hello,docker
script: |
hello
docker --help![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent