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

Use SHA instead of master in rli links #5434

Merged
merged 1 commit into from
May 30, 2024
Merged

Conversation

neverett
Copy link
Contributor

@neverett neverett commented May 30, 2024

Why are the changes needed?

When flytesnacks example code is updated, the monodocs build in flyte often breaks because the remoteliteralinclude references in flyte docs point to specific line numbers for that example code in the master branch of flytesnacks. This PR updates the master references to a specific SHA -- essentially prioritizing stability over freshness for example code.

(In the long run, the best solution is probably to move docs to their own repository so monodocs failures don't cause build failures in the flyte repo, and put some automation in place in flytesnacks to test the monodocs build in that repo against remoteliteralinclude references to the specific branch in a given flytesnacks PR.)

What changes were proposed in this pull request?

Updates rli references to point to a URL with a SHA (the most recent SHA in flytesnacks master as of this PR) instead of a reference to the master branch of flytesnacks.

How was this patch tested?

Tested locally with no build failures and code in user guide docs rendered as expected.

Check all the applicable boxes

  • All new and existing tests passed.
  • All commits are signed-off.

Docs link

User guide: https://flyte--5434.org.readthedocs.build/en/5434/user_guide/

See example here: https://flyte--5434.org.readthedocs.build/en/5434/user_guide/advanced_composition/decorating_tasks.html

@neverett neverett requested a review from eapolinario May 30, 2024 16:01
@neverett neverett self-assigned this May 30, 2024
@neverett neverett requested a review from ppiegaze as a code owner May 30, 2024 16:01
Copy link

codecov bot commented May 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.11%. Comparing base (22d81c6) to head (80187f3).
Report is 137 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5434   +/-   ##
=======================================
  Coverage   61.10%   61.11%           
=======================================
  Files         793      793           
  Lines       51169    51169           
=======================================
+ Hits        31269    31270    +1     
+ Misses      17028    17027    -1     
  Partials     2872     2872           
Flag Coverage Δ
unittests-datacatalog 69.31% <ø> (ø)
unittests-flyteadmin 58.90% <ø> (ø)
unittests-flytecopilot 17.79% <ø> (ø)
unittests-flytectl 68.34% <ø> (ø)
unittests-flyteidl 79.30% <ø> (ø)
unittests-flyteplugins 61.94% <ø> (ø)
unittests-flytepropeller 57.32% <ø> (ø)
unittests-flytestdlib 65.82% <ø> (+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.

@neverett neverett merged commit 715496a into master May 30, 2024
50 checks passed
@neverett neverett deleted the nikki/docs/use-shas-for-rli branch May 30, 2024 17:37
robert-ulbrich-mercedes-benz pushed a commit to robert-ulbrich-mercedes-benz/flyte that referenced this pull request Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants