Add scripts and tasks to publish docs to github pages #2430
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,4 +35,7 @@ coverage.txt | |
| test/e2e/e2e\.test | ||
|
|
||
| # mkdocs | ||
| site | ||
|
|
||
| # temporal github pages | ||
| gh-pages | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # Copyright 2018 The Kubernetes Authors. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| if ! [ -z $DEBUG ]; then | ||
| set -x | ||
| fi | ||
|
|
||
| DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" | ||
|
|
||
| if [ "$COMPONENT" != "docs" ]; then | ||
| echo "This task runs only to publish docs" | ||
| exit 0 | ||
| fi | ||
|
|
||
| make -C ${DIR}/.. build-docs | ||
|
|
||
| git config --global user.email "[email protected]" | ||
| git config --global user.name "Travis Bot" | ||
|
|
||
| git clone --branch=gh-pages --depth=1 https://${GH_REF} ${DIR}/gh-pages | ||
|
There was a problem hiding this comment. I'm curious to know why There was a problem hiding this comment. I can change that but I found so many different ways that I choose this one. I can change this There was a problem hiding this comment. No need to, I haven't looked into the tool myself. |
||
| cd ${DIR}/gh-pages | ||
|
|
||
| git rm -r . | ||
|
|
||
| cp -r ${DIR}/../site/* . | ||
|
|
||
| git add . | ||
| git commit -m "Deploy GitHub Pages" | ||
| git push --force --quiet "https://${GH_TOKEN}@${GH_REF}" gh-pages > /dev/null 2>&1 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,7 +57,7 @@ EOF | |
| } | ||
|
|
||
| case "$1" in | ||
| ingress-controller|nginx|docs) | ||
| publish $TRAVIS_CI_TOKEN $1 | ||
| ;; | ||
| *) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -213,3 +213,11 @@ dep-ensure: | |
| .PHONY: dev-env | ||
| dev-env: | ||
| @./hack/build-dev-env.sh | ||
|
|
||
| .PHONY: live-docs | ||
| live-docs: | ||
| @docker run --rm -it -p 3000:3000 -v ${PWD}:/docs aledbf/mkdocs:0.1 | ||
|
There was a problem hiding this comment. What is this? Something custom? There was a problem hiding this comment. There was a problem hiding this comment. I will create a repo for this image (I don't want to install mkdocs in my machine to test the docs or run a local copy) There was a problem hiding this comment. @ElvinEfendi repository of the mkdocs image https://github.com/aledbf/mkdocs |
||
|
|
||
| .PHONY: build-docs | ||
| build-docs: | ||
| @docker run --rm -it -v ${PWD}:/docs aledbf/mkdocs:0.1 build | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Who do we not need
TRAVIS_TIMEOUTanymore?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was required only for the s390x and ppc64le nginx images. Right now I am building that with an AWS VM