search

flyteorg / flyte

Scalable and flexible workflow orchestration platform that seamlessly unifies data, ML and analytics stacks.
https://flyte.org
Apache License 2.0
5.17k stars 551 forks source link

Use SHA instead of master in rli links #5434

Closed neverett closed 1 month ago

neverett commented 1 month ago

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

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

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 61.11%. Comparing base (22d81c6) to head (80187f3).

Additional details and impacted files ```diff @@ 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](https://app.codecov.io/gh/flyteorg/flyte/pull/5434/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | Coverage Δ | | |---|---|---| | [unittests-datacatalog](https://app.codecov.io/gh/flyteorg/flyte/pull/5434/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `69.31% <ø> (ø)` | | | [unittests-flyteadmin](https://app.codecov.io/gh/flyteorg/flyte/pull/5434/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `58.90% <ø> (ø)` | | | [unittests-flytecopilot](https://app.codecov.io/gh/flyteorg/flyte/pull/5434/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `17.79% <ø> (ø)` | | | [unittests-flytectl](https://app.codecov.io/gh/flyteorg/flyte/pull/5434/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `68.34% <ø> (ø)` | | | [unittests-flyteidl](https://app.codecov.io/gh/flyteorg/flyte/pull/5434/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `79.30% <ø> (ø)` | | | [unittests-flyteplugins](https://app.codecov.io/gh/flyteorg/flyte/pull/5434/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `61.94% <ø> (ø)` | | | [unittests-flytepropeller](https://app.codecov.io/gh/flyteorg/flyte/pull/5434/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `57.32% <ø> (ø)` | | | [unittests-flytestdlib](https://app.codecov.io/gh/flyteorg/flyte/pull/5434/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg) | `65.82% <ø> (+0.02%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flyteorg#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.