Skip to content
box

GitHub Action

devbox installer

v0.11.0 Latest version

devbox installer

box

devbox installer

Install Devbox in your CICD workflow

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: devbox installer

              
  uses: jetify-com/[email protected]
Learn more about this action in jetify-com/devbox-install-action

Choose a version

devbox-install-action

This action downloads the devbox CLI and installs the Nix packages defined in your devbox.json.

version tests

Example Workflow

name: Testing with devbox

on: push

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Install devbox
        uses: jetify-com/[email protected]

      - name: Run arbitrary commands
        run: devbox run -- echo "done!"

      - name: Run a script called test
        run: devbox run test

Configure Action

Action Inputs

Input argument description default
project-path Path to the folder that contains a valid devbox.json repo's root directory
enable-cache Cache the entire Nix store in github based on your devbox.json false
refresh-cli Specify whether the CLI should be redownloaded false
devbox-version Specify devbox CLI version you want to pin to. Only supports >0.2.2 latest
sha256-checksum Specify an explicit checksum for the devbox binary
disable-nix-access-token Disable configuration of nix access-tokens with the GitHub token used in the workflow false
skip-nix-installation Skip the installation of nix false

Example Configuration

Here's an example job with all inputs:

- name: Install devbox
  uses: jetify-com/[email protected]
  with:
    project-path: 'path-to-folder'
    enable-cache: 'true'
    refresh-cli: 'false'
    devbox-version: 0.10.4
    disable-nix-access-token: 'false'
    sha256-sum: f5907e5782f6e1f5a7ca32c8ae2a0a81618549314bab237174a46fb216f43809