update.sh 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186
  1. #!/bin/bash
  2. set -Eeuo pipefail
  3. cd "$(dirname "$(readlink -f "$BASH_SOURCE")")"
  4. helperDir='.template-helpers'
  5. # usage: ./update.sh [--namespace NAMESPACE] [[NAMESPACE/]IMAGE ...]
  6. # ie: ./update.sh
  7. # ./update.sh debian golang
  8. # ./update.sh --namespace tianontesting debian golang
  9. # ./update.sh tianontesting/debian tianontestingmore/golang
  10. # BASHBREW_ARCH=windows-amd64 BASHBREW_ARCH_NAMESPACES='...' ./update.sh --namespace winamd64
  11. forceNamespace=
  12. if [ "${1:-}" = '--namespace' ]; then
  13. shift
  14. forceNamespace="$1"
  15. shift
  16. fi
  17. images=( "$@" )
  18. if [ ${#images[@]} -eq 0 ]; then
  19. images=( */ )
  20. fi
  21. images=( "${images[@]%/}" )
  22. if [ -n "$forceNamespace" ]; then
  23. images=( "${images[@]/#/"$forceNamespace/"}" )
  24. fi
  25. replace_field() {
  26. targetFile="$1"
  27. field="$2"
  28. content="$3"
  29. extraSed="${4:-}"
  30. sed_escaped_value="$(echo "$content" | sed 's/[\/&]/\\&/g')"
  31. sed_escaped_value="${sed_escaped_value//$'\n'/\\n}"
  32. sed -ri -e "s/${extraSed}%%${field}%%${extraSed}/$sed_escaped_value/g" "$targetFile"
  33. }
  34. for image in "${images[@]}"; do
  35. repo="${image##*/}"
  36. namespace="${image%$repo}"
  37. namespace="${namespace%/}"
  38. # this is used by subscripts to determine whether we're pushing /_/xxx or /r/ARCH/xxx
  39. # (especialy for "supported tags")
  40. export ARCH_SPECIFIC_DOCS=
  41. if [ -n "$namespace" ] && [ -n "${BASHBREW_ARCH:-}" ]; then
  42. export ARCH_SPECIFIC_DOCS=1
  43. fi
  44. if [ -x "$repo/update.sh" ]; then
  45. ( set -x; "$repo/update.sh" "$image" )
  46. fi
  47. if [ -e "$repo/content.md" ]; then
  48. githubRepo="$(cat "$repo/github-repo")"
  49. maintainer="$(cat "$repo/maintainer.md")"
  50. issues="$(cat "$repo/issues.md" 2>/dev/null || cat "$helperDir/issues.md")"
  51. getHelp="$(cat "$repo/get-help.md" 2>/dev/null || cat "$helperDir/get-help.md")"
  52. license="$(cat "$repo/license.md" 2>/dev/null || true)"
  53. licenseCommon="$(cat "$repo/license-common.md" 2>/dev/null || cat "$helperDir/license-common.md")"
  54. if [ "$license" ]; then
  55. license=$'\n\n''# License'$'\n\n'"$license"$'\n\n'"$licenseCommon"
  56. fi
  57. logo=
  58. logoFile=
  59. for f in png svg; do
  60. if [ -e "$repo/logo.$f" ]; then
  61. logoFile="$repo/logo.$f"
  62. break
  63. fi
  64. done
  65. if [ "$logoFile" ]; then
  66. logoCommit="$(git log -1 --format='format:%H' -- "$logoFile" 2>/dev/null || true)"
  67. [ "$logoCommit" ] || logoCommit='master'
  68. if [ "${logoFile##*.}" = 'svg' ]; then
  69. logo="![logo](https://cdn.rawgit.com/docker-library/docs/$logoCommit/$logoFile)"
  70. else
  71. logo="![logo](https://raw.githubusercontent.com/docker-library/docs/$logoCommit/$logoFile)"
  72. fi
  73. fi
  74. stack=
  75. stackYml=
  76. stackUrl=
  77. if [ -f "$repo/stack.yml" ]; then
  78. stack="$(cat "$repo/stack.md" 2>/dev/null || cat "$helperDir/stack.md")"
  79. stackYml=$'```yaml\n'"$(cat "$repo/stack.yml")"$'\n```'
  80. stackCommit="$(git log -1 --format='format:%H' -- "$repo/stack.yml" 2>/dev/null || true)"
  81. [ "$stackCommit" ] || stackCommit='master'
  82. stackUrl="https://raw.githubusercontent.com/docker-library/docs/$stackCommit/$repo/stack.yml"
  83. fi
  84. compose=
  85. composeYml=
  86. if [ -f "$repo/docker-compose.yml" ]; then
  87. compose="$(cat "$repo/compose.md" 2>/dev/null || cat "$helperDir/compose.md")"
  88. composeYml=$'```yaml\n'"$(cat "$repo/docker-compose.yml")"$'\n```'
  89. fi
  90. deprecated=
  91. if [ -f "$repo/deprecated.md" ]; then
  92. deprecated=$'# **DEPRECATION NOTICE**\n\n'
  93. deprecated+="$(cat "$repo/deprecated.md")"
  94. deprecated+=$'\n\n'
  95. fi
  96. targetFile="$repo/README.md"
  97. {
  98. cat "$helperDir/autogenerated-warning.md"
  99. echo
  100. echo -n "$deprecated"
  101. cat "$helperDir/template.md"
  102. } > "$targetFile"
  103. echo ' TAGS => generate-dockerfile-links-partial.sh "'"$repo"'"'
  104. partial="$("$helperDir/generate-dockerfile-links-partial.sh" "$repo")"
  105. if [ -z "$partial" ]; then
  106. if [ -n "$ARCH_SPECIFIC_DOCS" ]; then
  107. partial='**No supported tags found!**'$'\n\n''It is very likely that `%%REPO%%` does not support the currently selected architecture (`'"$BASHBREW_ARCH"'`).'
  108. else
  109. echo >&2 'error: missing TAGS for '"$repo"'!'
  110. exit 1
  111. fi
  112. fi
  113. replace_field "$targetFile" 'TAGS' "$partial"
  114. echo ' ARCHES => arches.sh "'"$repo"'"'
  115. arches="$("$helperDir/arches.sh" "$repo")"
  116. [ "$arches" ]
  117. replace_field "$targetFile" 'ARCHES' "$arches"
  118. echo ' CONTENT => '"$repo"'/content.md'
  119. replace_field "$targetFile" 'CONTENT' "$(cat "$repo/content.md")"
  120. echo ' VARIANT => variant.sh'
  121. replace_field "$targetFile" 'VARIANT' "$("$helperDir/variant.sh" "$repo")"
  122. # has to be after CONTENT because it's contained in content.md
  123. echo " LOGO => $logo"
  124. replace_field "$targetFile" 'LOGO' "$logo" '\s*'
  125. echo ' STACK => '"$repo"'/stack.md'
  126. replace_field "$targetFile" 'STACK' "$stack"
  127. echo ' STACK-YML => '"$repo"'/stack.yml'
  128. replace_field "$targetFile" 'STACK-YML' "$stackYml"
  129. echo ' STACK-URL => '"$repo"'/stack.yml'
  130. replace_field "$targetFile" 'STACK-URL' "$stackUrl"
  131. echo ' COMPOSE => '"$repo"'/compose.md'
  132. replace_field "$targetFile" 'COMPOSE' "$compose"
  133. echo ' COMPOSE-YML => '"$repo"'/docker-compose.yml'
  134. replace_field "$targetFile" 'COMPOSE-YML' "$composeYml"
  135. echo ' LICENSE => '"$repo"'/license.md'
  136. replace_field "$targetFile" 'LICENSE' "$license"
  137. echo ' ISSUES => "'"$issues"'"'
  138. replace_field "$targetFile" 'ISSUES' "$issues"
  139. echo ' GET-HELP => "'"$getHelp"'"'
  140. replace_field "$targetFile" 'GET-HELP' "$getHelp"
  141. echo ' MAINTAINER => "'"$maintainer"'"'
  142. replace_field "$targetFile" 'MAINTAINER' "$maintainer"
  143. echo ' IMAGE => "'"$image"'"'
  144. replace_field "$targetFile" 'IMAGE' "$image"
  145. echo ' REPO => "'"$repo"'"'
  146. replace_field "$targetFile" 'REPO' "$repo"
  147. echo ' GITHUB-REPO => "'"$githubRepo"'"'
  148. replace_field "$targetFile" 'GITHUB-REPO' "$githubRepo"
  149. echo
  150. else
  151. echo >&2 "skipping $repo: missing repo/content.md"
  152. fi
  153. done