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: update development.md #106

Merged
merged 16 commits into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion .github/workflows/build-push.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:

jobs:
docker_publish:
name: Build, Tag, and Push Images
name: Build, Tag, and Push Image
runs-on: ubuntu-latest

strategy:
Expand Down
15 changes: 7 additions & 8 deletions development.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,20 @@ This is essentially equivalent to running `make image-push TAG=<tag>` in the exa
1. Create a PR for your changes. Once merged, it will trigger a workflow to build and push the images for all the examples,
with the tag `stable`. 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 a new change is made.
2. After the changes have been merged it is encouraged to update the dependency management files so that the version
2. If the change that you have introduced is a breaking change, then after merge you should update the dependency management files so that the version
displayed in the `go.mod` file reflects the commit SHA of the merged changes. This can be done by getting the
commit SHA of the merged changes and using it with the update script. Alternatively, you can provide the specific version that you would like to update to, or even
pass in `latest` to fetch the latest version from the remote repository:
```shell
./update_examples.sh -u <SDK-version | commit-sha | latest>
```
After running the script, create another PR for these changes.
After running the script, create another PR for these changes. Ideally, the update script should only be need to run when a new version is released, i.e. provide a version or `latest` to it,
or when a breaking change is merged before the next release, i.e. provide a commit SHA to it. If your merged change is a small chore, then it is unnecessary to run the update script as we want to
avoid flooding the commit history with dependency updates.

Updating the version may not seem necessary since we are using local references. However, the client prints
out information related to the server, which includes the SDK version, which is retrieved from the `go.mod` file.
After a change is merged, even though the images will be using the most up to date SDK
version, if the dependency management files are not updated, the logs will print the previous commit SHA as the SDK version.
After a change is merged/new release, even though the images will be using the most up to date SDK
version, if the dependency management files are not updated, the logs will print the previous version as the current SDK version.
Thus, in order for the correctness of the server information, consistency, and to avoid future confusion, it is recommended
to update the `numaflow-go` dependency version across all the example directories, after a change has been made to the SDK.



to update the `numaflow-go` dependency version across all the example directories, after a large/breaking change or new release.
2 changes: 1 addition & 1 deletion update_examples.sh
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we move this script hack/ dir?

Copy link
Member Author

@ayildirim21 ayildirim21 Mar 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will open a pr to do that

Edit: #107

Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ if (( usingBuildPush + usingBuildPushExample + usingVersion + usingHelp > 1 ));
exit 1
fi

if (( usingTag + usingVersion + usingHelp > 1 || (usingTag && usingBuildPush + usingBuildPushExample == 0) )); then
if (( (usingTag + usingVersion + usingHelp > 1) || (usingTag && usingBuildPush + usingBuildPushExample == 0) )); then
echo "Can only use -t with -bp or -bpe" >&2
show_help
exit 1
Expand Down
Loading