update.sh 4.8 KB

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