hub-builder is a simple interface for building & validating Jina Hub executors. It is built on top of jina hub interface. It can be used as a Github action in the CICD workflow, or via CLI.
One can use it as a part of CI pipeline, to build and test images in the Pull Request. Simply copy-paste the following YAML file into .github/workflows/hub-builder.yml.
name: Hub Builder
on: [pull_request]
jobs:
hub-builder:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Jina Hub Image Builder
uses: jina-ai/hub-builder@masterOn every new PR, the builder will find all modified manifest.yml recursively (deleting is excluded) and try to build an Hub image from it, one by one. That means, when you update an image, you must change manifest.yml to trigger the build, e.g. you can simply bump version field in manifest.yml.
| Name | Description | Default |
|---|---|---|
push |
if push to Docker Hub and MongoDB | False |
dockerhub_username |
user name of the docker registry | |
dockerhub_password |
the plaintext password of the docker hub | |
dockerhub_registry |
the URL to the registry | https://index.docker.io/v1/ |
slack_webhook |
the webhook for Slack notification | |
jina_version |
the version of Jina for building hub image | latest |
Notes: the input argument jina_version is different from the version of jina for running the pod in the container.
The later should be set in your_jina_pod/requirements.txt. The jina_version is the version of jina when building the pod image.
There are two outputs you can use in the post-action:
| Name | Description |
|---|---|
success_targets |
Successfully built targets with their paths |
failed_targets |
Failed built targets with their paths |
To use the output values, you have to refer to the step by id, e.g.
jobs:
test_hubbuilder:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Hub builder step
id: hubbuild # later we can refer to this step
uses: ./ # Uses an action in the root directory
continue-on-error: true
- name: Get the output
run: echo "success ${{ steps.hubbuild.outputs.success_targets }} failed ${{ steps.hubbuild.outputs.failed_targets }}"
pip install -r requirements.txt
python app.py --helppython app.py /abcpython app.py /abc --dry-runNote that dry-run only checks the name conventions, required files. No actual testing and building.
Simply open the build-TIMESTAMP.json, there you have a complete overview of this build round and details of each executors.
We welcome all kinds of contributions from the open-source community, individuals and partners. Without your active involvement, Jina won't be successful.
Please first read the contributing guidelines before the submission.
We have a simple test case to ensure the correctness of the PR to this action. As this action monitors the change of manifest.yml, to trigger the action, you have to modify manifest.yml, e.g. by bumping the version number.
Commit the changes above along with your PR, it will trigger the CI. If both expectations are met, then your PR is good to go.
Copyright (c) 2020 Jina AI Limited. All rights reserved.
Jina is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.