From af1c196d1d2be4ba8173f8d8ded3c862a6abb3f8 Mon Sep 17 00:00:00 2001 From: a3hadi Date: Thu, 27 Jun 2024 08:58:42 -0400 Subject: [PATCH 1/2] chore: remove unnecessary flag Signed-off-by: a3hadi --- development.md | 12 ++++-------- hack/update_examples.sh | 23 ++++++----------------- 2 files changed, 10 insertions(+), 25 deletions(-) diff --git a/development.md b/development.md index 90e116d..1b0af13 100644 --- a/development.md +++ b/development.md @@ -16,19 +16,15 @@ directories match) and then build all example images. Now that the images are available locally, you can take the desired image and test it in a pipeline -If you want to build and push all the example images at once, you can run: +You can build and push a specific example image by running the following: ```shell -./hack/update_examples.sh -bp -t -``` +./hack/update_examples.sh -bpe -t + ``` The default tag is `stable`, but it is recommended you specify your own for testing purposes, as the Github Actions CI uses the `stable` tag. This consistent tag name is used so that the tags in the [E2E test pipelines](https://github.com/numaproj/numaflow/tree/main/test) do not need to be updated each time an SDK change is made. -You can alternatively build and push a specific example image by running the following: -```shell -./hack/update_examples.sh -bpe -t - ``` -Both `-bpe` and `-bp` first build a local image with the naming convention +`-bpe`first builds a local image with the naming convention `numaflow-java-examples/:`, which then gets pushed as `quay.io/numaio/numaflow-java/:`. If you want to build and tag all images locally, without pushing to quay.io, as mentioned in step 3, run: `mvn clean install -Ddocker.tag=`. diff --git a/hack/update_examples.sh b/hack/update_examples.sh index ea52461..542ec0f 100755 --- a/hack/update_examples.sh +++ b/hack/update_examples.sh @@ -1,9 +1,8 @@ #!/bin/bash function show_help () { - echo "Usage: $0 [-h|--help | -t|--tag ] (-bp|--build-push | -bpe|--build-push-example )" + echo "Usage: $0 [-h|--help | -t|--tag ] (-bpe|--build-push-example )" echo " -h, --help Display help message and exit" - echo " -bp, --build-push Build all the examples and push them to the quay.io registry" echo " -bpe, --build-push-example Build the given example id (found in examples/pom.xml), and push it to the quay.io registry" echo " -t, --tag To be optionally used with -bpe or -bp. Specify the tag to build with. Default tag: stable" } @@ -15,7 +14,6 @@ if [ $# -eq 0 ]; then fi usingHelp=0 -usingBuildPush=0 usingBuildPushExample=0 usingTag=0 executionID="" @@ -27,9 +25,6 @@ function handle_options () { -h | --help) usingHelp=1 ;; - -bp | --build-push) - usingBuildPush=1 - ;; -bpe | --build-push-example) if [ -z "$2" ]; then echo "execution ID of example not specified." >&2 @@ -64,14 +59,14 @@ function handle_options () { handle_options "$@" -if (( usingBuildPush + usingBuildPushExample + usingHelp > 1 )); then - echo "Only one of '-h', '-bp', or '-bpe' is allowed at a time" >&2 +if (( usingBuildPushExample + usingHelp > 1 )); then + echo "Only one of '-h' or '-bpe' is allowed at a time" >&2 show_help exit 1 fi -if (( (usingTag + usingHelp > 1) || (usingTag && usingBuildPush + usingBuildPushExample == 0) )); then - echo "Can only use -t with -bp or -bpe" >&2 +if (( (usingTag + usingHelp > 1) || (usingTag && usingBuildPushExample == 0) )); then + echo "Can only use -t with -bpe" >&2 show_help exit 1 fi @@ -114,13 +109,7 @@ function build () { fi } -if (( usingBuildPush )); then - build - for id in "${executionIDs[@]}" - do - dockerPublish "$id" - done -elif (( usingBuildPushExample )); then +if (( usingBuildPushExample )); then build dockerPublish "$executionID" elif (( usingHelp )); then From 97933cae65a30c1bb9884cf47f9129f761ed809e Mon Sep 17 00:00:00 2001 From: Keran Yang Date: Thu, 27 Jun 2024 10:47:03 -0400 Subject: [PATCH 2/2] Update development.md --- development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/development.md b/development.md index 1b0af13..8eda450 100644 --- a/development.md +++ b/development.md @@ -24,7 +24,7 @@ The default tag is `stable`, but it is recommended you specify your own for test This consistent tag name is used so that the tags in the [E2E test pipelines](https://github.com/numaproj/numaflow/tree/main/test) do not need to be updated each time an SDK change is made. -`-bpe`first builds a local image with the naming convention +`-bpe` first builds a local image with the naming convention `numaflow-java-examples/:`, which then gets pushed as `quay.io/numaio/numaflow-java/:`. If you want to build and tag all images locally, without pushing to quay.io, as mentioned in step 3, run: `mvn clean install -Ddocker.tag=`.