Expand description
Deployer
Deployer is a relatively simple, yet powerful localhost CI/CD instrument.
§Features
- Local and remote pipeline execution.
- Several pipeline drivers: standard (Deployer), shell.
- Auto-generate Docker/Podman and Ansible configs and run pipelines inside images or at remote hosts.
- Export pipeline to shell scripts, GitHub Actions & GitLab CI configurations.
- Resolve variables for actions with
.env-files, any shell command or even HashiCorp Vault KV2 storage. - Move build & run caches away of your project’s directory. Only artifacts and
.depl/config.yamlfile. - Watch and rebuild your project automatically via
depl watch. - Use internal versioned content storage and autopatching system on pipeline runs.
§Usability features
- YAML configuration format, but you may use only your terminal with Deployer’s TUI.
- Global localhost action and pipeline registries.
- Built-in documentation via
depl docs. - Automatic checks of actions requirements before pipeline execution.
- Automatic artifacts delivery to
./artifactsfolder. - Wide selection of settings and launch options.
For simple user guides, check README.md and DOCS.md. For software developer look, check DeployerProjectOptions.
Modules§
- actions
- Actions module.
- ansible
- Ansible module.
- cd
- Change directory to pipeline run’s one.
- cmd
- CMD module.
- compose
- Compose module.
- containered
- Containered module.
- entities
- Entities module.
- github
- GitHub CI/CD module.
- gitlab
- GitLab CI/CD module.
- globals
- Configurations module.
- pipelines
- Pipelines module.
- project
- Project module.
- remote
- Remote module.
- run
- Run module.
- rw
- R/W utils module.
- storage
- Storage module.
- systemd
- Systemd service module.
- tui
- Terminal UI module.
- utils
- Other Deployer utils.
- watch
- Deployer’s watcher module.
Macros§
Statics§
- ARTIFACTS_
DIR - Artifacts directory name.
- BUILD_
CACHE_ LIST - Cache list filename.
- CACHE_
DIR - Cache directory name.
- CTRLC_
HANDLER - Current working process to interrupt when I/O is piped.
- GLOBAL_
CONF - Global configuration filename.
- LOGS_
DIR - Logs directory name.
- PROJECT_
CONF - Deployer project configuration’s possible filenames.
- STORAGE_
DIR - Storage directory name.
Functions§
- install_
ctrlc_ handler - Sets up
Ctrl+Cinterruption to kill the running sub-process and exit.