Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/starptech/bootme
Configurable and extendable Task pipeline. Define hooks and revert your changes on failure.
https://github.com/starptech/bootme
bootstrapper node-js queue scaffolding
Last synced: 21 days ago
JSON representation
Configurable and extendable Task pipeline. Define hooks and revert your changes on failure.
- Host: GitHub
- URL: https://github.com/starptech/bootme
- Owner: StarpTech
- License: mit
- Created: 2017-11-05T12:59:46.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-30T08:35:23.000Z (over 6 years ago)
- Last Synced: 2024-10-06T09:20:07.345Z (about 1 month ago)
- Topics: bootstrapper, node-js, queue, scaffolding
- Language: JavaScript
- Homepage:
- Size: 414 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
```
npm install bootme
```
[](#badge)
[](https://travis-ci.org/StarpTech/bootme)
[](https://ci.appveyor.com/project/StarpTech/bootme)
[](https://coveralls.io/github/StarpTech/bootme?branch=master)
[](https://lernajs.io/)
[](https://www.npmjs.com/package/bootme)
## Core features
- **Hooks**: define `Init`, `Before`, `After`, `Rollback` Hooks in the Task or with the Registry.
- **Rollback**: the pipeline behaves fully transactional. Define rollback routines which are triggered as soon as a `Hook`, `Task` or a `Job` or nested thing fail.
- **Configuration**: configure your Task with JSON or pass an [inquirer](https://github.com/SBoudrias/Inquirer.js) prompt to setup your config at runtime.
- **Composable**: work with results of previous Tasks, pass Tasks to Hooks or add Tasks in Tasks.
- **100% asynchronous**: all the core is implemented with asynchronous code. ES7 allow us to write good readable code.
- **Validation**: you can validate the result and config of your Task with [Joi](https://github.com/hapijs/joi).
- **CLI Wizards**: create beautiful Command-line Wizards with [ease](examples/basic-wizard.js).
- **Queue**: the order of execution is guaranteed thanks to [Workq](https://github.com/delvedor/workq) package.
## Usage
```js
const Bootme = require('bootme')
const registry = new Bootme.Registry()
const pipeline = new Bootme.Pipeline(registry)
// Share configuration across all tasks
registry.shareConfig({
TOKEN: process.env.TOKEN
})
class SampleTask extends Bootme.Task {
constructor(name) {
super(name)
}
async init(state) {}
async action(state) {}
async validateResult(value) {}
async validateConfig(value) {}
async rollback(state) {}
}
const task = new SampleTask('sample')
task.setConfig({ a: 1 })
// Add task
registry.addTask(task)
// Add hooks after registration "onInit", "onAfter", "onBefore"
registry.addHook('sample', 'onRollback', async (state) => ...)
// Add Global pipeline hooks "onTaskStart", "onTaskEnd", "onTaskRollback"
pipeline.onRollbackFinish(async () => ...)
// Execute or restore pipeline
pipeline.execute()
pipeline.restore()
```
## Examples
* [Simple](/examples/simple.js)
* [Config](/examples/config.js)
* [Restore](/examples/restore.js)
* [Rollback](/examples/rollback.js)
* [Hooks](/examples/hooks.js)
* [Task template](/examples/task-template.js)
* [Advanced](/examples/template.js)
## Documentation
* [Api](/docs/api.md)
* [Lifecycle](/docs/lifecycle.md)
## Tools
| General | Version | Description |
|--------|-------|-------|
| [bootme-cli](https://github.com/starptech/bootme/tree/master/packages/bootme-cli) | [](https://www.npmjs.com/package/bootme-cli) | Run Bootme Tasks from the console |
| [bootme-json-runner](https://github.com/starptech/bootme/tree/master/packages/bootme-json-runner) | [](https://www.npmjs.com/package/bootme-json-runner) | Load pipeline configuration from JSON |
| [bootme-task-spinner](https://github.com/starptech/bootme/tree/master/packages/bootme-task-spinner) | [](https://www.npmjs.com/package/bootme-task-spinner) | Elegant terminal spinner when your Tasks are running |
## Tasks
| General | Version | Description |
|--------|-------|-------|
| [bootme-githook](https://github.com/starptech/bootme/tree/master/packages/bootme-githook) | [](https://www.npmjs.com/package/bootme-githook) | Cross-platform git hooks |
| [bootme-request](https://github.com/starptech/bootme/tree/master/packages/bootme-request) | [](https://www.npmjs.com/package/bootme-request) | Start HTTP request |
| [bootme-gitclone](https://github.com/starptech/bootme/tree/master/packages/bootme-gitclone) | [](https://www.npmjs.com/package/bootme-gitclone) | Clone a Git Repository |
| [bootme-template](https://github.com/starptech/bootme/tree/master/packages/bootme-template) | [](https://www.npmjs.com/package/bootme-template) | Mustache Templating |
| [bootme-shell](https://github.com/starptech/bootme/tree/master/packages/bootme-shell) | [](https://www.npmjs.com/package/bootme-shell) | Portable Unix shell commands |
| [bootme-docker](https://github.com/starptech/bootme/tree/master/packages/bootme-docker) | [](https://www.npmjs.com/package/bootme-docker) | Docker commands |
| [bootme-temp](https://github.com/starptech/bootme/tree/master/packages/bootme-temp) | [](https://www.npmjs.com/package/bootme-temp) | Get a random temporary file or directory path |
| [bootme-delay](https://github.com/starptech/bootme/tree/master/packages/bootme-delay) | [](https://www.npmjs.com/package/bootme-delay) | Include a delay |
## Share Project Templates
| General | Version | Description |
|--------|-------|-------|
| [bootme-projectx](https://github.com/starptech/bootme/tree/master/packages/bootme-projectx) | [](https://www.npmjs.com/package/bootme-projectx) | Example of how to share a JSON pipeline definition |
## FAQ
### What's the difference between BootMe and Gulp ?
[Gulp](https://gulpjs.com/) is a tookit to work with streams, transform or move bytes from one place to another. While you can parallize stuff in Gulp, in BootMe you can't, we don't want! Bootstrapping an environment from scratch or setup projects are error-prone this means we should be able to define a rollback mechanism to come back in a clear state and try it again. BootMe Task-Pipeline is ordered and as soon a task fail, the pipeline is trying to recover itself. You can hook into many lifecycle events. In Gulp you can pipe streams to other tasks this is quite useful because you can build modules which are composable. In BootMe it's quite different. We don't agree on streams, we respond native Javascript Objects. A task can rely on the output of another task. This is possible, because a Task can define `refs` which is part of the task configuration and defines a relation between them. When the value can not be found we trying to fallback to the default configuration. We are also able to validate the config and the result of a task. In Gulp you don't want it because the correctnes of the stream data could be reached only near the end.
BootMe is no replacement for Gulp, we use Gulp e.g in `bootme-template` to manipulate files and replace them with the orginal content.
### What's the difference between BootMe and Grunt ?
[Grunt](https://gruntjs.com) is more similiar to BootMe as Gulp because in Grunt you have a sequential execution order of you tasks. Grunt don't rely on streams you can do everything inside a task but Grunt don't respect transactionality, a task can fail or another task can succeed. Therefore grunt don't provide an easy way to handle errors or hooks into specific lifecycle events. Grunt don't handle config and output validation for you, you have to extend it manually. The goal of grunt is to provide a general solution of running any kind of task but that's not exact our goal with BootMe. BootMe was designed to provide an elegant API to handle a list of tasks as a transaction and rollback the tasks of the pipeline when an error occur. Another big difference related to the technology is that BootMe is written in ES7. You can have fun!
BootMe is no replacement for Grunt, grunt is a great tool to automate your asset build pipeline.
### Can I define my pipeline in a JSON file?
Yes, we provide a JSON runner [bootme-json-runner](https://github.com/starptech/bootme/tree/master/packages/bootme-json-runner). If you pass a Javascript Object you can even hook into the lifecycle.
### Can I run a single Task with the command-line?
Yes, we provide great tooling with [bootme-cli](https://github.com/starptech/bootme/tree/master/packages/bootme-cli)
### Can I create project templates?
Yes, look at example project [bootme-projectx](https://github.com/starptech/bootme/tree/master/packages/bootme-projectx) there we defined the pipeline in Javascript and published it to NPM (As convention all packages has to started with `bootme-*`). After you have successfully published your package you can execute your pipeline with one command with [bootme-cli](https://github.com/starptech/bootme/tree/master/packages/bootme-cli).
## Contributing
### Run Tests
```
lerna run test
```
### Debugging
We use the excellent [Debug](https://github.com/visionmedia/debug) package.
```
$env:DEBUG = "bootme:*" // Windows
```