mentor-api

Usage

A docker image that serves an api for question/answer sessions using prerecorded mentor videos and an AI classifier building on mentor-classifier

Development

Any changes made to this repo should be covered by tests. To run the existing tests:

make test

All pushed commits must also pass format and lint checks. To check all required tests before a commit:

make test-all

To fix formatting issues:

make format

Releases

Currently, this image is semantically versioned. When making changes that you want to test in another project, create a branch and PR and then you can release a test tag one of two ways:

To build/push a work-in-progress tag of mentor-api for the current commit in your branch

• find the docker_tag_commit workflow for your commit in circleci
• approve the workflow
• this will create a tag like https://hub.docker.com/mentor-api:${COMMIT_SHA}

To build/push a pre-release semver tag of mentor-api for the current commit in your branch

• create a github release from your development branch with tag format /^\d+\.\d+\.\d+(-[a-z\d\-.]+)?$/ (e.g. 1.0.0-alpha.1)
• find the docker_tag_release workflow for your git tag in circleci
• approve the workflow
• this will create a tag like uscictdocker/mentor-api:1.0.0-alpha.1

Once your changes are approved and merged to master, you should create a release tag in semver format as follows:

• create a github release from master with tag format /^\d+\.\d+\.\d$/ (e.g. 1.0.0)
• find the docker_tag_release workflow for your git tag in circleci
• approve the workflow
• this will create a tag like uscictdocker/mentor-api:1.0.0