⚠️ this project has been deprecated with the move to Tekton

Boomerang Flow Lifecycle Worker

This is the Boomerang Flow Lifecycle Worker that runs as init and sidecar container for the Custom Flow Task or Bring Your Own container task in Flow.

Depends on:

• Boomerang Flow Worker
• Boomerang Worker CLI
• Boomerang Worker Core

Packaging

CICD

This project is built, tested, and packaged via the Boomerang CICD system hosted and provided by IBM.

Manual

VERSION=1.1.0 && docker build -t boomerangio/worker-lifecycle:$VERSION . && docker push boomerangio/worker-lifecycle:$VERSION

Available Scripts

npm run dev

Execute boomerang-worker-cli in local mode. Used for local development.

npm run dev:debug

Execute boomerang-worker-cli in local and debug mode

npm run format

Format your code with Prettier

npm run lint

Lint your .js files with ESLint

npm start

Execute boomerang-worker-cli. Used for execution in worker environment. There are assumptions made about files and directories available.

npm run test

Execute unit tests with Jest

npm run test:coverage

Execute unit tests with Jest and generate coverage report

Testing

Jest is included as a test runner with scripts to execute unit tests and generate code coverage reports.

Project Configuration

The template includes configuration for the following:

• Code Formatting via Prettier
• Linting via ESLint
• Precommit hooks via Husky
• Commit standards via Commitlint (not configured by default, but recommended)

Enable commit standards via Conventional Commits by adding the following to your package.json.

"husky": {
    "hooks": {
      "commit-msg": "commitlint -e $HUSKY_GIT_PARAMS",
    }
  }

Troubleshooting

• Make sure that your commands directory only includes .js files that export modules. The CLI will try to register every matching file in it.