Download the PHP package donut-org/donut without Composer
On this page you can find all versions of the php package donut-org/donut. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download donut-org/donut
More information about donut-org/donut
Files in donut-org/donut
Package donut
Short Description Runs workflow files over unix commands
License BSD-3-Clause
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package donut
Donut
Donut runs workflows described in JSON files. A workflow is a list of steps; each step runs one unix command, and the steps pass values to each other through a flat map of strings.
These workflows used to be bash scripts calling other bash scripts. Bash has no way to say this step needs these values — a mistyped variable name is an empty string, and an empty string is a perfectly good argument. Donut declares inputs up front, checks before it starts that every value a step reads is written by something earlier, and refuses to run a workflow that fails the check.
The documentation is in Czech; the messages Donut prints are English.
docs/format-specifikace.md is the reference for the format.
Installation
Download the latest package or use Composer:
Donut requires PHP 8.4 or later.
Donut reads blocks and workflows from a profile, not from the current directory. Create the default one:
DONUT_PROFILE=name picks another profile, DONUT_HOME=path another root
of profiles. To use a set that lives elsewhere — in a project repository,
say — symlink it in: ln -s ~/projects/olw/donut ~/.config/donut/olw.
Example
Donut looks for blocks/ and workflows/ in the profile, by default
~/.config/donut/default/:
A block wraps one command and declares what it needs:
A workflow is a list of steps, with its own inputs coming from the command line:
Run it. The first line is progress, written to stderr as each step runs; the second is the step's own output:
And ask it what it takes:
Commands never go through a shell — Donut passes arguments to execve as a
list, so a value containing a space, a quote or a semicolon is just a value.
Exit codes: 0 the workflow finished, 1 a step failed while running, 2 it never started (bad arguments, unknown workflow, failed validation). The difference is there for automation: 2 means retrying is pointless.
Documentation
In Czech:
docs/format-specifikace.md |
the format — blocks, workflows, the map, templates, validation |
docs/zadani.md |
what this is for and what is left to build |
docs/workflows/donut/ |
a real workload — 15 blocks and 4 workflows |
docs/superpowers/specs/ |
the design document behind each part |
Also see donut-org/donut-ui — authoring environment for workflows and blocks.
License: New BSD License
Author: Jan Pecha, https://www.janpecha.cz/
