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

Enable relative links in Docker image tags tables #1446

Merged
merged 3 commits into from
Sep 25, 2024

Conversation

lbussell
Copy link
Contributor

@lbussell lbussell commented Sep 23, 2024

Context: dotnet/dotnet-docker#5872 (comment)

This allows specifying useRelativeLinks in the manifest per each readme, and if it's set, then the link to the Dockerfiles in the tags table for that readme will be a relative link instead of a GitHub permalink.

This is where you would specify this in the manifest: https://github.com/dotnet/dotnet-docker/blob/08e0e7c3345a75af15ca0c1733d4f07676e0997d/manifest.json#L21-L24

@lbussell lbussell requested a review from a team as a code owner September 23, 2024 23:59
Copy link

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

1 similar comment
Copy link

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

Copy link
Member

@mthalman mthalman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In what scenario would we not use relative links?

@lbussell
Copy link
Contributor Author

In what scenario would we not use relative links?

Good point. I'll edit this to make them all use relative links. Should simplify the code some.

@lbussell
Copy link
Contributor Author

lbussell commented Sep 24, 2024

I have updated the code to output relative links for readmes, but keep GitHub permalinks for MCR tags metadata, since we do push that metadata to MCR and they could decide to use those links again at any time. Also added tests.

@lbussell lbussell requested a review from mthalman September 24, 2024 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants