Thanks to visit codestin.com
Credit goes to github.com

Skip to content

chore: update development and releasing docs to reflect latest changes #184

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Jul 15, 2024
Merged

chore: update development and releasing docs to reflect latest changes #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a765458
chore: update development and releasing docs to reflect latest changes
ayildirim21 Jul 12, 2024
0648e08
modify development.md
ayildirim21 Jul 12, 2024
09e7cbd
modify development.md
ayildirim21 Jul 12, 2024
8187294
modify development.md
ayildirim21 Jul 12, 2024
80e11f4
modify development.md
ayildirim21 Jul 12, 2024
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
9 changes: 5 additions & 4 deletions development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ This document explains the development process for the Numaflow Python SDK.

1. Install [Poetry](https://python-poetry.org/docs/) before starting your test. Make sure you have the correct Python version
2. Make your SDK changes
3. Update the `example.py` inside the same example directory if needed
4. Run `make image` inside the same example directory to build your image
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.
Please check [Numaflow](https://numaflow.numaproj.io/) for more details
3. Update the `example.py` file inside the desired example directory if needed
4. Run `make image TAG=<tag>` inside the same example directory to build your image with an appropriate tag
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. Ensure to update the image tag in
the `pipeline.yaml` file to the one you used when building your image

Each example directory has a Makefile which can be used to build, tag, and push images.
If you want to build and tag the image and then immediately push it to quay.io, use the `image-push` target.
Expand Down
2 changes: 1 addition & 1 deletion releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ the version in the root `pyproject.toml` should be updated (for [reference](http
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
3. After making these changes, create a PR. Once merged, it will trigger the `Docker Publish` workflow, and should be included in the release.
As a result, the correct SDK version will always be printed in the server information logs, and
the example images will always be using the latest changes (due to referencing the local SDK tarball that is built)
the example images will always be using the latest changes (due to the local references)

### How to Release

Expand Down