Skip to content

Commit 8af8bb9

Browse files
committed
Add explaination on prototype beta in docker version script
1 parent 43a3126 commit 8af8bb9

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

.github/scripts/prototype-docker-version.sh

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
#!/bin/sh
22

3+
# This script is ran whenever a PR is made to implement a Meilisearch prototype.
4+
# For example if Meilisearch creates a prototype for radioactive search, the SDK may implement a way to try out the radioactive search.
5+
# Nonetheless, the tests of this implentation should run against the prototype and not the latest release of Meilisearch.
6+
# To be able to do so, Meilisearch creates a docker image with the changes.
7+
# The purpose of this script is to find the correct docker image containing the changes.
8+
# For example,
9+
# The radioactive search docker image is named `v0.30.0-radioactive-search.beta.0`
10+
# our branch is named `prototype/radioactive-search.0`
11+
# Using the branch name, this script is going to retrieve the name of the docker image.
12+
313
# See https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables for references on GITHUB_REF_NAME
414
prototype_branch=$1 # $GITHUB_REF_NAME
515
prototype_branch=$(echo $prototype_branch | sed -r 's/prototype-beta\///') # remove pre-prending prototype-beta/

0 commit comments

Comments
 (0)