Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: remove unnecessary flag #124

Merged
merged 2 commits into from
Jun 27, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <tag>
```
./hack/update_examples.sh -bpe <example-execution-id> -t <tag>
```
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 <example-execution-id> -t <tag>
```
Both `-bpe` and `-bp` first build a local image with the naming convention
`-bpe`first builds a local image with the naming convention
KeranYang marked this conversation as resolved.
Show resolved Hide resolved
`numaflow-java-examples/<example-execution-id>:<tag>`, which then gets pushed as
`quay.io/numaio/numaflow-java/<example-execution-id>:<tag>`. 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=<tag>`.
Expand Down
23 changes: 6 additions & 17 deletions hack/update_examples.sh
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
#!/bin/bash

function show_help () {
echo "Usage: $0 [-h|--help | -t|--tag <tag>] (-bp|--build-push | -bpe|--build-push-example <execution-id>)"
echo "Usage: $0 [-h|--help | -t|--tag <tag>] (-bpe|--build-push-example <execution-id>)"
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"
}
Expand All @@ -15,7 +14,6 @@ if [ $# -eq 0 ]; then
fi

usingHelp=0
usingBuildPush=0
usingBuildPushExample=0
usingTag=0
executionID=""
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading