https://github.com/krdlab/daab-workflow

Workflow engine for daab
https://github.com/krdlab/daab-workflow

daab workflow

Last synced: 11 days ago
JSON representation

Workflow engine for daab

• Host: GitHub
• URL: https://github.com/krdlab/daab-workflow
• Owner: krdlab
• License: mit
• Created: 2021-09-26T17:01:59.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-28T17:41:46.000Z (9 months ago)
• Last Synced: 2024-10-28T09:09:24.760Z (2 months ago)
• Topics: daab, workflow
• Language: TypeScript
• Homepage:
• Size: 810 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# daab-workflow

This package is a workflow engine for daab. You only need to define your workflow in YAML. daab will work according to your workflow.

## Usage

### 1. Create your daab

First of all, create a directory for your daab and initialize it.

```bash

mkdir my-daab && cd $_

daab init

```

After initialization, log in to direct.

```bash

daab login

```

### 2. Install daab-workflow

Add `daab-workflow` to your daab dependencies.

```bash

npm install daab-workflow

```

Next, create a directory in daab to place your workflow file.

```bash

mkdir workflows

```

### 3. Create your workflow

Add a new workflow file to the directory you just created.

```bash

vim workflows/hello.yml

```

More information on how to write a workflow can be found in `example/workflows/*.yml`.

### 4. Run daab

Implement `scripts/*.js` as follows.

```javascript

const { workflow } = require("daab-workflow");

module.exports = workflow('./workflows');

```

Implement `*.ts` as follows if you use TypeScript.

```typescript

import { workflow } from 'daab-workflow';

export = workflow('./workflows');

```

Finally, run daab as usual.

```bash

DISABLE_NPM_INSTALL=yes npm start

```

## Contribution

TODO