Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scalastic/wizard
WIP - Welcome to Wizard, a versatile and magical framework that empowers you to effortlessly execute uniform integration scripts both locally and on your server. It caters to the needs of both developers and CI/CD platforms, weaving a touch of magic into your workflow.
https://github.com/scalastic/wizard
cicd gitlab-ci jenkins local shell wizard
Last synced: about 1 month ago
JSON representation
WIP - Welcome to Wizard, a versatile and magical framework that empowers you to effortlessly execute uniform integration scripts both locally and on your server. It caters to the needs of both developers and CI/CD platforms, weaving a touch of magic into your workflow.
- Host: GitHub
- URL: https://github.com/scalastic/wizard
- Owner: scalastic
- License: mit
- Created: 2023-03-19T11:36:59.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-05T17:15:55.000Z (8 months ago)
- Last Synced: 2024-10-12T19:48:10.238Z (2 months ago)
- Topics: cicd, gitlab-ci, jenkins, local, shell, wizard
- Language: Shell
- Homepage:
- Size: 789 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/scalastic/wizard/blob/master/LICENSE)
[](https://www.gnu.org/software/bash/)
[](https://github.com/scalastic/wizard/actions/workflows/workflow.yml)
[](https://codecov.io/gh/scalastic/wizard)
[](https://img.shields.io/github/v/release/scalastic/wizard)
[](https://img.shields.io/github/stars/scalastic/wizard?style=social)
[](https://img.shields.io/github/forks/scalastic/wizard?style=social)
# Wizard - The Magical Integration Framework
Welcome to Wizard, a versatile and magical framework that empowers you to effortlessly execute uniform integration scripts both locally and on your server. It caters to the needs of both developers and CI/CD platforms, weaving a touch of magic into your workflow.
The acronym `WIZARD` represents its essence: **Wide Integration Zone And Runner Deployment**. Thanks to its unconventional and almost mystical nature, `Wizard` bridges the gap between developers and CI/CD platforms, enabling the seamless execution of identical integration and deployment scripts, whether on your local machine or the server.
With `Wizard`, developers gain the magical ability to thoroughly test their CI/CD pipeline's functionality directly on their local workstations, eliminating the need to speculate about the outcomes once their code is pushed to the integration servers.
Embrace the enchantment of Wizard to fill the void in the DevOps approach and embody the "shift-left" principle with a sprinkle of magic.
----
## Table of Contents
- [Supported platforms](#supported-platforms)
- [Supported technologies and extensibility](#supported-technologies-and-extensibility)
- [Requirements](#requirements)
- [Installation](#installation)
- [Tutorial](#tutorial)
- [Wizard CLI](#wizard-cli)
- [Command options](#command-options)
- [Project directory](#project-directory)
- [Typical directory structure](#typical-directory-structure)
- [Options file](#options-file)
- [For developers](#for-developers)
- [Related projects](#related-projects)
- [Contributions](#contributions)
## Supported platforms
## Compatible Platforms
Currently, `Wizard` is tailored for seamless use on the following platforms:
- [ ] Your local environment (Unix-based systems)
- [x] Jenkins
- [ ] GitLab-CI (_WIP_)
Please note that our magical integration framework may expand its compatibility with more platforms in the future. Stay tuned for updates!
## Prerequisites
In order to utilize `Wizard` on your local machine, the following prerequisites must be met:
- [Bash](https://www.gnu.org/software/bash/) version 4.4 or newer
- [Git](https://git-scm.com/) version 2.0 or higher
- [Docker](https://www.docker.com/) version 19.03 or later
## Installation
### Install with Homebrew (_WIP_)
```bash
brew tap scalastic/tap
brew install wizard
```
### Install with Git
```bash
git clone
```
## Tutorial
## Wizard CLI
### Usage (_WIP_)
```bash
wizard [options] [command]
```
### Command options
| Option | Description |
| --- |---------------------------------------|
| -h, --help | Display help for command |
| -v, --version | Display version of Wizard |
| -d, --debug | Display debug information |
| -q, --quiet | Do not display any output |
| -c, --config | Specify the configuration file to use |
| -p, --project | Specify the project directory to use |
| -l, --log | Specify the log file to use |
| -t, --trace | Specify the trace file to use |
| -e, --env | Specify the environment file to use |
| -i, --input | Specify the input file to use |
## Project directory
### Typical directory structure
```text
directory
├─ .shellspec [recommended]
│
├─ config/
│ ├─ sequence-default.json [default] Default configuration
│ ├─ sequence-project1.json [specific] Your specific configuration
│ :
|
├─ coverage/ [optional] Ignore from version control
|
├─ lib/
│ ├─ your_library1.sh
│ :
│
├─ spec/ (also )
│ ├─ spec_helper.sh [recommended]
│ ├─ banner[.md] [optional]
│ ├─ support/ [optional]
│ │
│ ├─ bin/
│ │ ├─ your_script1_spec.sh
│ │ :
│ ├─ lib/
│ │ ├─ your_library1_spec.sh
```
### Options file
## For developers
### Related projects
- [getoptions](https://github.com/ko1nksm/getoptions) - An elegant option parser for shell scripts (full support for all POSIX shells).
- [Inline](https://github.com/carlocorradini/inline) - Inline script sources.
- [ShellSpec](https://github.com/shellspec/shellspec) - A full-featured BDD unit testing framework for dash, bash, ksh, zsh and all POSIX shells that provides first-class features such as code coverage, mocking, parameterized test, parallel execution and more.
- [ShellCheck](https://github.com/koalaman/shellcheck) - A static analysis tool for shell scripts.
- [ShellMetrics](https://github.com/shellspec/shellmetrics) - ShellMetrics is Cyclomatic Complexity Analyzer for shell script.
- [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) - A specification for adding human and machine readable meaning to commit messages.
- [Semantic Versioning](https://semver.org/) - Semantic Versioning 2.0.0.
### Contributions (_WIP_)
All contributions are welcome!
Please read the [contribution guidelines](CONTRIBUTING.md) before submitting a pull request.
## License
[MIT](LICENSE)