docker-library
/
docs
mirror of https://github.com/docker-library/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adjust "tag list too long" description to make the full link more obvious 

Also, adjust `neo4j` to always defer the supported tag listing to GitHub.
This commit is contained in:
Tianon Gravi 2021-06-24 14:26:13 -07:00
parent 28e2c3e256
commit 1bd03c064c
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
push.pl
View File

@ -74,24 +74,31 @@ sub prompt_for_edit {
my $proposedFile = shift; my $proposedFile = shift;
my $lengthLimit = shift // 0; my $lengthLimit = shift // 0;
my $proposedText = Mojo::File->new($proposedFile)->slurp or warn 'missing ' . $proposedFile; my $proposedText = Mojo::File->new($proposedFile)->slurp // '** FILE MISSING! **';
$proposedText = trim(decode('UTF-8', $proposedText)); $proposedText = trim(decode('UTF-8', $proposedText));
# remove our warning about generated files (Hub doesn't support HTML comments in Markdown) # remove our warning about generated files (Hub doesn't support HTML comments in Markdown)
$proposedText =~ s% ^ <!-- .*? --> \s* %%sx; $proposedText =~ s% ^ <!-- .*? --> \s* %%sx;
if ($lengthLimit > 0 && length($proposedText) > $lengthLimit) { my $alwaysShortTags = ($proposedFile eq 'neo4j/README.md');
if ($alwaysShortTags || ($lengthLimit > 0 && length($proposedText) > $lengthLimit)) {
# TODO https://github.com/docker/hub-beta-feedback/issues/238 # TODO https://github.com/docker/hub-beta-feedback/issues/238
my $fullUrl = "$githubBase/$proposedFile"; my $fullUrl = "$githubBase/$proposedFile";
my $tagsNote = "**Note:** the description for this image is longer than the Hub length limit of $lengthLimit, so the \"Supported tags\" list has been trimmed to compensate. The full list can be found at [$fullUrl]($fullUrl#supported-tags-and-respective-dockerfile-links). See [docker/hub-beta-feedback#238](https://github.com/docker/hub-beta-feedback/issues/238) for more information.\n\n"; my $shortTags = "-\tSee [\"Supported tags and respective \`Dockerfile\` links\" at $fullUrl]($fullUrl#supported-tags-and-respective-dockerfile-links)\n\n";
my $tagsNote = "**Note:** the description for this image is longer than the Hub length limit of $lengthLimit, so the \"Supported tags\" list has been trimmed to compensate. See [docker/hub-beta-feedback#238](https://github.com/docker/hub-beta-feedback/issues/238) for more information.\n\n" . $shortTags;
my $genericNote = "**Note:** the description for this image is longer than the Hub length limit of $lengthLimit, so has been trimmed. The full description can be found at [$fullUrl]($fullUrl). See [docker/hub-beta-feedback#238](https://github.com/docker/hub-beta-feedback/issues/238) for more information.\n\n"; my $genericNote = "**Note:** the description for this image is longer than the Hub length limit of $lengthLimit, so has been trimmed. The full description can be found at [$fullUrl]($fullUrl). See [docker/hub-beta-feedback#238](https://github.com/docker/hub-beta-feedback/issues/238) for more information.\n\n";
$tagsNote = $shortTags if $alwaysShortTags;
my $trimmedText = $proposedText; my $trimmedText = $proposedText;
# if our text is too long for the Hub length limit, let's first try removing the "Supported tags" list and add $tagsNote and see if that's enough to let us put the full image documentation # if our text is too long for the Hub length limit, let's first try removing the "Supported tags" list and add $tagsNote and see if that's enough to let us put the full image documentation
$trimmedText =~ s%^(# Supported tags and respective `Dockerfile` links\n\n).*?\n(?=# |\[)%$1$tagsNote%ms; $trimmedText =~ s%^(# Supported tags and respective `Dockerfile` links\n\n).*?\n(?=# |\[)%$1$tagsNote%ms;
# (we scrape until the next "h1" or a line starting with a link which is likely a build status badge for an architecture-namespace) # (we scrape until the next "h1" or a line starting with a link which is likely a build status badge for an architecture-namespace)
$proposedText = $trimmedText if $alwaysShortTags;
if (length($trimmedText) > $lengthLimit) { if (length($trimmedText) > $lengthLimit) {
# ... if that doesn't do the trick, then do our older naïve description trimming # ... if that doesn't do the trick, then do our older naïve description trimming
$trimmedText = $genericNote . substr $proposedText, 0, ($lengthLimit - length($genericNote)); $trimmedText = $genericNote . substr $proposedText, 0, ($lengthLimit - length($genericNote));