Discourse | Documentation | Blog | Twitter
Installs flox on GitHub Actions for the supported platforms: Linux and macOS. Available on the GitHub Marketplace.
Flox is a virtual environment and package manager all in one. With Flox you create environments that layer and replace dependencies just where it matters, making them portable across the full software lifecycle.
Install packages from the biggest open source repository (nixpkgs) that contains more than 80,000 packages.
Create .github/workflows/ci.yml in your repo with the following contents:
name: "CI"
on:
pull_request:
push:
jobs:
tests:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install flox
uses: flox/[email protected]
- name: Build
run: flox build| Input | Description | Default |
|---|---|---|
version |
Select a specific version from a channel | "" |
channel |
One of: stable, qa, nightly, or a commit hash |
"stable" |
disable-metrics |
Disable sending anonymous usage statistics to flox | "false" |
retries |
Number of retries for downloading and installing Flox | "3" |
- name: Install flox
uses: flox/[email protected]
with:
channel: nightly
retries: "5"Most packages from Nixpkgs are available via the Flox Catalog. These are pre-built and downloaded from the Flox binary cache, except for packages that cannot be redistributed in binary format.
For custom packages, use flox build and flox publish to get binary caching out of the box with a FloxHub account.
Note: If you're familiar with Nix and prefer managing your own infrastructure, see flox/configure-nix-action for setting up a custom binary cache. This is significantly more complex and not recommended for most users.
Ask on Discourse, Matrix, Discord, or Twitter.
File an issue or open a pull request on the flox/install-flox-action repository.
MIT licensed. See LICENSE.