Skip to content

Commit 32a9d26

Browse files
authored
chore: update development and releasing docs to reflect latest changes (#184)
Signed-off-by: a3hadi <[email protected]>
1 parent bf2b55a commit 32a9d26

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

development.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@ This document explains the development process for the Numaflow Python SDK.
66

77
1. Install [Poetry](https://python-poetry.org/docs/) before starting your test. Make sure you have the correct Python version
88
2. Make your SDK changes
9-
3. Update the `example.py` inside the same example directory if needed
10-
4. Run `make image` inside the same example directory to build your image
11-
5. Now that you have the image with your customized example and code change, you can test it in a Numaflow pipeline. Example pipelines, `pipeline.yaml`, are also provided in most of the example directories.
12-
Please check [Numaflow](https://numaflow.numaproj.io/) for more details
9+
3. Update the `example.py` file inside the desired example directory if needed
10+
4. Run `make image TAG=<tag>` inside the same example directory to build your image with an appropriate tag
11+
5. Now that you have the image with your customized example and code change, you can test it in a Numaflow pipeline.
12+
Example pipelines, `pipeline.yaml`, are also provided in most of the example directories. Ensure to update the image tag in
13+
the `pipeline.yaml` file to the one you used when building your image
1314

1415
Each example directory has a Makefile which can be used to build, tag, and push images.
1516
If you want to build and tag the image and then immediately push it to quay.io, use the `image-push` target.

releases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ the version in the root `pyproject.toml` should be updated (for [reference](http
1313
you must update the `MINIMUM_NUMAFLOW_VERSION` constant in the `pynumaflow/info/types.py` file to the minimum Numaflow version that is supported by your new SDK version
1414
3. After making these changes, create a PR. Once merged, it will trigger the `Docker Publish` workflow, and should be included in the release.
1515
As a result, the correct SDK version will always be printed in the server information logs, and
16-
the example images will always be using the latest changes (due to referencing the local SDK tarball that is built)
16+
the example images will always be using the latest changes (due to the local references)
1717

1818
### How to Release
1919

0 commit comments

Comments
 (0)