majordomus deploy slug
Assemble the tree a provider receives into a directory outside the checkout
majordomus deploy slug
Usage
majordomus deploy slug [OPTIONS]Arguments
| argument | value | default | description |
|---|---|---|---|
| --deployment | <DEPLOYMENT> | — | The deployment (default: the one deployment that names a provider) |
| --commit | <COMMIT> | — | The commit every file is read at (default HEAD) |
| --executable | <EXECUTABLE> | required | The executable built at that commit |
| --out | <OUT> | required | The directory the slug is written into: outside the checkout, absent or empty |
| --repo | <PATH> | — | Start the search for the repository root here (default: the current directory) (accepted by every subcommand) |
| --discovery | vcs | filesystem | vcs | How declarative files are enumerated (accepted by every subcommand)
|
| --strict | flag | — | Refuse to proceed when any file of the layer carries an error diagnostic (accepted by every subcommand) |
| --share | <DIR> | — | The tool distribution's share directory (kinds.yaml, schemas/); default: $MAJORDOMUS_SHARE, then the repository's own share/, then the one beside the executable (accepted by every subcommand) |
| --format | text | json | text | Output shape (accepted by every subcommand)
|
Examples
-
A repository whose deployments name no provider has no tree to assemble
Nothing hosts a deployment that names no provider, so there is no slug: refused with exit 15, and nothing is written. Where a deployment names one, `--commit <sha> --executable <built at that commit> --out <a directory outside the checkout>` writes its build inputs at that commit, the provider's generated files at the slug's root, the buildpack line, the executable and `.majordomus/SOURCE.json` — the tree the provider workflow pushes.
$ majordomus deploy slug --executable majordomus --out /nonexistent/slugWhat it asserts: exits 15.
Tested by apps/majordomus-cli/tests/cli_examples.rs, which runs the command against the built executable and asserts what the page states.
Where this comes from
Declared once in apps/majordomus-cli/src/cli.rs: clap for the structure, typed Rust metadata beside it for the examples. This page, majordomus deploy slug --help, docs/generated/cli.md and docs/generated/cli.json are projections of that one declaration.
The whole command line on one page: the registry's command-line page. The task lifecycle (init, start, finish, doctor, ...) belongs to the shell tool, a different program: Commands and its specification.