Skip to content

contributing.md

Latest commit

 

History

History
93 lines (77 loc) · 2.66 KB

contributing.md

File metadata and controls

93 lines (77 loc) · 2.66 KB

Contributing

This reference shows each supported command using the ilma entrypoint and the direct bash commands/<command>.sh entrypoint. Examples assume you are in the repository root and you have run the sandbox setup.

Sandbox

Create a realistic fixture and a sample archive used by later examples:

tools/make-dummies.sh /tmp/ilma-dummies
export DUMMIES=/tmp/ilma-dummies
export PATH="$PWD:$PATH"
mkdir -p "$DUMMIES/artifacts"
ilma backup "$DUMMIES/dummy-project-python" --archive --target "$DUMMIES/artifacts"
ARCHIVE_PATH="$(ls -t "$DUMMIES"/artifacts/dummy-project-python-*.tar.zst | head -n 1)"

Command reference

backup

Create a backup directory (default command if you omit the subcommand).

ilma backup "$DUMMIES/dummy-project-python"
bash commands/backup.sh "$DUMMIES/dummy-project-python"

config

Print the resolved configuration for a project (local config plus defaults).

ilma config "$DUMMIES/dummy-project-js"
bash commands/config.sh "$DUMMIES/dummy-project-js"

Project litter review was split out of ilma into dil. This repository now only documents the archival, extraction, validation, and remote pull surfaces that remain in ilma.

validate

Check configuration and dependency state for a project.

ilma validate "$DUMMIES/dummy-project-js"
bash commands/validate.sh "$DUMMIES/dummy-project-js"

extract

Extract an archive using safe tar options (uses ARCHIVE_PATH from the sandbox).

ilma extract "$ARCHIVE_PATH"
bash commands/extract.sh "$ARCHIVE_PATH"

decrypt

Show decrypt options and required flags (actual decrypt needs a .gpg archive).

ilma decrypt --help
bash commands/decrypt.sh --help

remote

List discovered remote job manifests. This creates a local manifest so the list command has something to display.

export ILMA_CONFIG_HOME="$DUMMIES/ilma-config"
mkdir -p "$ILMA_CONFIG_HOME/nodes"
printf '%s\n' \
  '[job]' \
  'id=local-demo' \
  'remote=localhost' \
  'stage_dir=/tmp/ilma-stage/local-demo' \
  '[manifest]' \
  '+ ./' \
  '- **' \
  > "$ILMA_CONFIG_HOME/nodes/local-demo.ini"
ilma remote list
bash commands/remote.sh list

Show remote pull options and the required job format.

ilma remote pull --help
bash commands/remote.sh pull --help

Testing

Run the full suite with tests/run.sh. Each test is a bash script under tests/, excluding tests/helpers.

tests/run.sh

Linting

Linting is managed by pre-commit. If you have it installed, run:

pre-commit run --all-files

The hooks run shfmt and shellcheck; the versions and arguments live in .pre-commit-config.yaml.