adobe / helix-dispatch

A Helix microservice that retrieves content from multiple sources and delivers the best match
Apache License 2.0
4 stars 2 forks source link
helix helix2 service

Helix Dispatch

A Helix microservice that retrieves content from multiple sources and delivers the best match

Status

codecov CircleCI GitHub license GitHub issues LGTM Code Quality Grade: JavaScript semantic-release

Installation

Not needed, the service is pre-installed as soon as you run hlx deploy.

Usage

Invoke the action using wsk

wsk action invoke helix-services/dispatch@v2 --result --blocking \
  -p static.owner trieloff \
  -p static.repo helix-demo \
  -p static.ref master \
  -p static.root htdocs \
  -p content.owner trieloff \
  -p content.repo helix-demo \
  -p content.ref master \
  -p content.package b7aa8a6351215b7e12b6d3be242c622410c1eb28 \
  -p path /index.html

Use the web action (replace trieloff with your GitHub user name)

curl "https://adobeioruntime.net/api/v1/web/trieloff/helix-services/dispatch%40v2?static.owner=trieloff&static.repo=trieloff&static.ref=master&static.root=htdocs&content.owner=trieloff&content.repo=helix-demo&content.ref=master&content.package=b7aa8a6351215b7e12b6d3be242c622410c1eb28&path=/index.html"

For a detailed list of all possible request parameters, check out the reference documentation.

Development

Deploying Helix Static

Deploying Helix Service requires the wsk command line client, authenticated to a namespace of your choice. For Project Helix, we use the helix namespace.

All commits to main that pass the testing will be deployed automatically. All commits to branches that will pass the testing will get commited as /helix-services/service@ci<num> and tagged with the CI build number.