Replace relative links in markdown files during build #69
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mitchell-elholm
approved these changes
Oct 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR modifies the package build to replace relative markdown links with absolute ones.
This is required for PyPI as the relative links do not work properly on the release page. See this page, which uses
https://pypi.org/project/aurora-dsql-django/0.2.0/reference/KNOWN_ISSUES.mdfor the "Known Issues" link instead of a link to the GitHub repo.I also added an additional step to the CI/CD workflow, since it was not verifying the
uv buildfor PRs. This is a good additional step to make sure we don't break something in the release process. It is especially relevant now since it will catch relative links that use./or../as soon as they are introduced. We could technically support these kinds of relative links but we don't use them right now and it's easier to worry about that if/when we need them.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.