Use SHA instead of master in rli links #5434
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 themaster
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