https://github.com/madjam002/nix-task

A task runner that lets you use the Nix language to write and orchestrate CI/CD pipelines
https://github.com/madjam002/nix-task

cicd nix nixos nixpkgs task-runner

Last synced: about 1 month ago
JSON representation

A task runner that lets you use the Nix language to write and orchestrate CI/CD pipelines

• Host: GitHub
• URL: https://github.com/madjam002/nix-task
• Owner: madjam002
• License: mit
• Created: 2022-08-23T02:13:20.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-11-21T22:15:48.000Z (about 2 months ago)
• Last Synced: 2024-11-21T23:20:38.379Z (about 2 months ago)
• Topics: cicd, nix, nixos, nixpkgs, task-runner
• Language: Nix
• Homepage:
• Size: 1.48 MB
• Stars: 5
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nix-task

> Not ready for use yet, no usable packages are exported from this repository

nix-task is a task/action runner that lets you use the Nix language to write simple tasks or entire CI/CD pipelines, as an alternative to tools like Make, Dagger, Taskfile, etc.

It is not a replacement of CI/CD runners like GitLab CI or GitHub Actions, and instead is designed to complement these tools by being called by CI/CD runners. This allows pipelines to be authored and run agnostic to any particular CI/CD runner.

## Examples

See [examples/nixMathHomework/flake.nix](examples/nixMathHomework/flake.nix) as an example.

## Documentation

Tasks will be collected recursively from the provided attr path, unless any attrset that is encountered has `_nixTaskDontRecurseTasks` set to true.

### Nix library

#### `nix-task.lib.mkTask`

```

nix-task.lib.mkTask({

  # other tasks that this task is dependant on

  deps =? [ other tasks ];

  # nix packages that should be made available to the PATH for task execution

  path =? [ nix pkgs here ];

  # script to run for this task

  run = string | { deps }: string;

  # script to run when entering a shell using `nix-task shell`

  shellHook ?= string | { deps }: string;

  id =? string;

})

```

### Bash stdlib available to tasks

#### `$out`

Returns the path to an output directory where output artifacts can be stored. For this directory to be available, `artifacts = [ "output" "file" "names" "here" ];` needs to be set on the `mkTask`.

#### `$IMPURE_HOME`

Returns the path to your user home directory.

#### `taskSetOutput `

Sets `` as the output of this task, which can be used by other tasks that depend on this task.

#### `taskRunInBackground `

Runs `` in the background of this task. Will be sent a SIGTERM when the task has finished and will wait for the process to gracefully terminate.

#### `taskRunFinally `

Runs `` when this task finishes either successfully or on error.

#### `taskGetDeps`

Dumps the deps and their outputs as JSON.

## License

Licensed under the MIT License.

View the full license [here](https://raw.githubusercontent.com/madjam002/nix-task/master/LICENSE).