From 5f6a7253321ffafdf84f53ea0253dd703b105c6b Mon Sep 17 00:00:00 2001 From: Sven Dowideit Date: Sun, 22 Jun 2014 20:10:00 -0700 Subject: [PATCH] add Docker version and branch to html header Docker-DCO-1.1-Signed-off-by: Sven Dowideit (github: SvenDowideit) --- Makefile | 2 ++ docs/Dockerfile | 6 +++++- docs/release.sh | 24 ++++++++++++++++++------ docs/theme/mkdocs/base.html | 8 +++++++- 4 files changed, 32 insertions(+), 8 deletions(-) diff --git a/Makefile b/Makefile index a8e4dc5ca1..2d07b39c3b 100644 --- a/Makefile +++ b/Makefile @@ -6,6 +6,7 @@ BINDDIR := bundles DOCSPORT := 8000 GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null) +GITCOMMIT := $(shell git rev-parse --short HEAD 2>/dev/null) DOCKER_IMAGE := docker$(if $(GIT_BRANCH),:$(GIT_BRANCH)) DOCKER_DOCS_IMAGE := docker-docs$(if $(GIT_BRANCH),:$(GIT_BRANCH)) DOCKER_MOUNT := $(if $(BINDDIR),-v "$(CURDIR)/$(BINDDIR):/go/src/github.com/dotcloud/docker/$(BINDDIR)") @@ -59,6 +60,7 @@ docs-build: cp ./VERSION docs/VERSION echo "$(GIT_BRANCH)" > docs/GIT_BRANCH echo "$(AWS_S3_BUCKET)" > docs/AWS_S3_BUCKET + echo "$(GITCOMMIT)" > docs/GITCOMMIT docker build -t "$(DOCKER_DOCS_IMAGE)" docs bundles: diff --git a/docs/Dockerfile b/docs/Dockerfile index 68dbbec594..329646ed01 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -28,8 +28,12 @@ WORKDIR /docs RUN VERSION=$(cat /docs/VERSION) &&\ GIT_BRANCH=$(cat /docs/GIT_BRANCH) &&\ + GITCOMMIT=$(cat /docs/GITCOMMIT) &&\ AWS_S3_BUCKET=$(cat /docs/AWS_S3_BUCKET) &&\ - echo "{% set docker_version = \"${VERSION}\" %}{% set docker_branch = \"${GIT_BRANCH}\" %}{% set aws_bucket = \"${AWS_S3_BUCKET}\" %}{% include \"beta_warning.html\" %}" > /docs/theme/mkdocs/version.html + sed -i "s/\$VERSION/$VERSION/g" /docs/theme/mkdocs/base.html &&\ + sed -i "s/\$GITCOMMIT/$GITCOMMIT/g" /docs/theme/mkdocs/base.html &&\ + sed -i "s/\$GIT_BRANCH/$GIT_BRANCH/g" /docs/theme/mkdocs/base.html &&\ + sed -i "s/\$AWS_S3_BUCKET/$AWS_S3_BUCKET/g" /docs/theme/mkdocs/base.html # note, EXPOSE is only last because of https://github.com/dotcloud/docker/issues/3525 EXPOSE 8000 diff --git a/docs/release.sh b/docs/release.sh index 2168dfe1ee..d579a307ba 100755 --- a/docs/release.sh +++ b/docs/release.sh @@ -18,7 +18,15 @@ EOF [ "$AWS_S3_BUCKET" ] || usage -#VERSION=$(cat VERSION) +VERSION=$(cat VERSION) + +if [ "$$AWS_S3_BUCKET" == "docs.docker.com" ]; then + if [ "${VERSION%-dev}" != "$VERSION" ]; then + echo "Please do not push '-dev' documentation to docs.docker.com ($VERSION)" + exit 1 + fi +fi + export BUCKET=$AWS_S3_BUCKET export AWS_CONFIG_FILE=$(pwd)/awsconfig @@ -50,7 +58,7 @@ build_current_documentation() { upload_current_documentation() { src=site/ - dst=s3://$BUCKET + dst=s3://$BUCKET$1 echo echo "Uploading $src" @@ -61,7 +69,7 @@ upload_current_documentation() { # a really complicated way to send only the files we want # if there are too many in any one set, aws s3 sync seems to fall over with 2 files to go - endings=( json html xml css js gif png JPG ) + endings=( json html xml css js gif png JPG ttf svg woff) for i in ${endings[@]}; do include="" for j in ${endings[@]}; do @@ -78,11 +86,8 @@ upload_current_documentation() { --exclude *.DS_Store \ --exclude *.psd \ --exclude *.ai \ - --exclude *.svg \ --exclude *.eot \ --exclude *.otf \ - --exclude *.ttf \ - --exclude *.woff \ --exclude *.rej \ --exclude *.rst \ --exclude *.orig \ @@ -99,3 +104,10 @@ setup_s3 build_current_documentation upload_current_documentation +# Remove the last version - 1.0.2-dev -> 1.0 +MAJOR_MINOR="v${VERSION%.*}" + +#build again with /v1.0/ prefix +sed -i "s/^site_url:.*/site_url: \/$MAJOR_MINOR\//" mkdocs.yml +build_current_documentation +upload_current_documentation "/$MAJOR_MINOR/" diff --git a/docs/theme/mkdocs/base.html b/docs/theme/mkdocs/base.html index d2bba34e40..8f2bd0603a 100644 --- a/docs/theme/mkdocs/base.html +++ b/docs/theme/mkdocs/base.html @@ -3,6 +3,12 @@ + +{% set docker_version = "$VERSION" %}{% set docker_commit = "$GITCOMMIT" %}{% set docker_branch = "$GIT_BRANCH" %}{% set aws_bucket = "$AWS_S3_BUCKET" %} + + + + {% if meta.page_description %}{% endif %} {% if meta.page_keywords %}{% endif %} {% if site_author %}{% endif %} @@ -59,7 +65,7 @@
- {% include "version.html" %} + {% include "beta_warning.html" %} {{ content }}