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

docs: improve documentation for overwriting existing images #5030

Merged
merged 3 commits into from
Mar 11, 2024

Conversation

jasonlai1218
Copy link
Contributor

@jasonlai1218 jasonlai1218 commented Mar 10, 2024

Tracking issue

Why are the changes needed?

  • Add instructions for overwriting an existing image using FLYTE_FORCE_PUSH_IMAGE_SPEC=True command
  • Provide code examples for overwriting an existing image using pyflyte run and ImageSpec.force_push()

What changes were proposed in this pull request?

  • Added FORCE_PUSH feature in ImageSpec file

How was this patch tested?

Setup process

Screenshots

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

flyteorg/flytekit#2234

Docs link

- Add instructions for overwriting an existing image using `FLYTE_FORCE_PUSH_IMAGE_SPEC=True` command
- Provide code examples for overwriting an existing image using `pyflyte run` and `ImageSpec.force_push()`

Signed-off-by: jason.lai <[email protected]>
@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels Mar 10, 2024
Copy link

codecov bot commented Mar 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.00%. Comparing base (a49284e) to head (51e5ee2).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5030      +/-   ##
==========================================
+ Coverage   58.98%   59.00%   +0.02%     
==========================================
  Files         645      645              
  Lines       55548    55548              
==========================================
+ Hits        32764    32776      +12     
+ Misses      20193    20181      -12     
  Partials     2591     2591              
Flag Coverage Δ
unittests 59.00% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

- Update the instructions for forcing an image rebuild with `FLYTE_FORCE_PUSH_IMAGE_SPEC=True` passed to `pyflyte` command or `force_push()` added to the ImageSpec

Signed-off-by: jason.lai <[email protected]>
- Update the code block language specifier to `python`

Signed-off-by: jason.lai <[email protected]>
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Mar 10, 2024
@pingsutw pingsutw merged commit 05b5543 into flyteorg:master Mar 11, 2024
49 checks passed
yubofredwang pushed a commit to yubofredwang/flyte that referenced this pull request Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants