From 4efd42ef429a051ff59d638d9a3a6bb12b937f54 Mon Sep 17 00:00:00 2001 From: Ivan Krutov Date: Sat, 28 Apr 2018 22:36:31 +0700 Subject: [PATCH] Added LICENSE, Dockerfile, CI files and docs draft --- .gitignore | 3 + .travis.yml | 57 ++++++ Dockerfile | 7 + LICENSE | 389 ++++++++++++++++++++++++++++++++++++ README.md | 8 +- docs/contributing.adoc | 50 +++++ docs/index.adoc | 20 ++ docs/quick-start-guide.adoc | 20 ++ main.go | 2 +- travis/docker-push.sh | 9 + travis/docs.sh | 36 ++++ 11 files changed, 599 insertions(+), 2 deletions(-) create mode 100644 .travis.yml create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 docs/contributing.adoc create mode 100644 docs/index.adoc create mode 100644 docs/quick-start-guide.adoc create mode 100755 travis/docker-push.sh create mode 100755 travis/docs.sh diff --git a/.gitignore b/.gitignore index 654db34..e0958b5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,5 @@ vendor ggr-ui + +.idea +*.iml diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..23af5a2 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,57 @@ +sudo: required +language: go + +go: + - 1.10.x + +services: + - docker + +script: + - go test -v -race -coverprofile=coverage.txt -covermode=atomic + - GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -ldflags "-X main.buildStamp=`date -u '+%Y-%m-%d_%I:%M:%S%p'` -X main.gitRevision=`git describe --tags || git rev-parse HEAD` -s -w" + - gox -os "linux darwin windows" -arch "amd64" -osarch="windows/386" -output "dist/{{.Dir}}_{{.OS}}_{{.Arch}}" -ldflags "-X main.buildStamp=`date -u '+%Y-%m-%d_%I:%M:%S%p'` -X main.gitRevision=`git describe --tags || git rev-parse HEAD` -s -w" + +before_install: + - go get -u github.com/golang/dep/cmd/dep + +install: + - go get -u github.com/mitchellh/gox # cross compile + - dep ensure + +deploy: + - provider: releases + api-key: $GITHUB_TOKEN + file_glob: true + file: dist/* + skip_cleanup: true + on: + tags: true + - provider: script + script: travis/docker-push.sh latest + skip_cleanup: true + on: + branch: master + - provider: script + script: travis/docker-push.sh $TRAVIS_TAG + skip_cleanup: true + on: + tags: true + - provider: script + script: travis/docker-push.sh latest-release + skip_cleanup: true + on: + tags: true + - provider: script + script: travis/docs.sh latest + skip_cleanup: true + on: + branch: master + - provider: script + script: travis/docs.sh $TRAVIS_TAG + skip_cleanup: true + on: + tags: true + +after_success: +- bash <(curl -s https://codecov.io/bash) -F unittests diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..d3467b9 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,7 @@ +FROM alpine:3.7 + +RUN apk add -U tzdata && rm -Rf /var/cache/apk/* +COPY ggr-ui /usr/bin + +EXPOSE 4444 +ENTRYPOINT ["/usr/bin/ggr-ui", "-quota-dir", "/etc/grid-router/quota"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7df301b --- /dev/null +++ b/LICENSE @@ -0,0 +1,389 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018+ Aerokube LLC + + 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. diff --git a/README.md b/README.md index f34f4bd..31d5af5 100644 --- a/README.md +++ b/README.md @@ -1 +1,7 @@ -# ggr-ui +# Ggr UI + +Ggr UI is a standalone daemon that automatically collects `/status` information from multiple [Selenoid](https://github.com/aerokube/selenoid) and returns it as a single `/status` API. When this daemon is running you can use [Selenoid UI](https://github.com/aerokube/selenoid-ui) to see the state of the entire cluster. + +## Complete Guide & Build Instructions + +Complete reference guide (including building instructions) can be found at: http://aerokube.com/ggr-ui/latest/ diff --git a/docs/contributing.adoc b/docs/contributing.adoc new file mode 100644 index 0000000..6456024 --- /dev/null +++ b/docs/contributing.adoc @@ -0,0 +1,50 @@ +== Contributing & Development + +To build Ggr UI: + +. Install https://golang.org/doc/install[Golang] + +. Setup `$GOPATH` https://github.com/golang/go/wiki/GOPATH[properly] + +. Get Ggr UI source: + + $ go get -d github.com/aerokube/ggr-ui + +. Go to project directory: + + $ cd $GOPATH/src/github.com/aerokube/ggr-ui + +. Checkout dependencies + + $ go get -u github.com/golang/dep/cmd/dep && dep ensure + +. Build source: + + $ go build + +. Run Ggr UI: + + $ ./ggr-ui --help + +[TIP] +==== +To build Docker container type: + +[source,bash] +---- +$ GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build +$ docker build -t ggr-ui:latest . +---- + +==== + +=== Documentation + +Locally can be generated with: + +[source,bash] +---- +$ docker run --rm -v `pwd`/docs/:/documents/ \ + asciidoctor/docker-asciidoctor \ + asciidoctor -D /documents/output/ index.adoc +---- diff --git a/docs/index.adoc b/docs/index.adoc new file mode 100644 index 0000000..b87f2e1 --- /dev/null +++ b/docs/index.adoc @@ -0,0 +1,20 @@ += Ggr UI +:revdate: {docdate} +:toc: left +:toclevels: 3 +:sectnums: +:sectanchors: +:Author: Alexander Andryashin and the Aerokube community +:revnumber: latest +:icons: font +:source-highlighter: coderay +:docinfo: shared + +This reference covers version: _{revnumber}_ + +Ggr UI is a standalone daemon that automatically collects `/status` information from multiple https://github.com/aerokube/selenoid[Selenoid] instances and returns it as a single `/status` API. When this daemon is running you can use https://github.com/aerokube/selenoid-ui[Selenoid UI] to see the state of the entire cluster. + +== Getting Started +include::quick-start-guide.adoc[leveloffset=+1] + +include::contributing.adoc[] diff --git a/docs/quick-start-guide.adoc b/docs/quick-start-guide.adoc new file mode 100644 index 0000000..2a55477 --- /dev/null +++ b/docs/quick-start-guide.adoc @@ -0,0 +1,20 @@ +== Quick Start Guide + +. Prerequisites: + * One or more https://github.com/aerokube/selenoid[Selenoid] hosts + * A directory with http://aerokube.com/ggr/latest/#_creating_quota_files[XML quota files] for Ggr +. Start Ggr UI binary or container: ++ +``` +$ ./ggr-ui -quota-dir /path/to/quota/dir # As a binary + +$ docker run -d --name ggr-ui -p 8888:8888 -v /path/to/quota/dir:/etc/grid-router/quota:ro aerokube/ggr-ui:latest-release +``` ++ +Binaries as usually can be downloaded from https://github.com/aerokube/ggr-ui/releases[releases page]. +. Now start https://github.com/aerokube/selenoid-ui[Selenoid UI] and point it to `http://localhost:8888`. It should start showing sessions running anywhere in Selenium cluster behind Ggr. +. You can also use `/status` API similarly to Selenoid http://aerokube.com/selenoid/latest/#_usage_statistics[/status] API: ++ +``` +$ curl -s http://localhost:8888/status +``` diff --git a/main.go b/main.go index bed3b5d..88772b1 100644 --- a/main.go +++ b/main.go @@ -66,7 +66,7 @@ func configure() error { func init() { flag.StringVar(&listen, "listen", ":8888", "host and port to listen to") flag.IntVar(&limit, "limit", 10, "simultaneous http requests") - flag.StringVar("aDir, "quotaDir", "quota", "quota directory") + flag.StringVar("aDir, "quota-dir", "quota", "quota directory") flag.DurationVar(&gracePeriod, "grace-period", 300*time.Second, "graceful shutdown period") flag.Parse() limitCh = make(chan struct{}, limit) diff --git a/travis/docker-push.sh b/travis/docker-push.sh new file mode 100755 index 0000000..ca5447f --- /dev/null +++ b/travis/docker-push.sh @@ -0,0 +1,9 @@ +#!/usr/bin/env bash + +set -e + +docker build -t $TRAVIS_REPO_SLUG . +docker tag $TRAVIS_REPO_SLUG $TRAVIS_REPO_SLUG:$1 +docker login -u="$DOCKER_USERNAME" -p="$DOCKER_PASSWORD" +docker push $TRAVIS_REPO_SLUG +docker push $TRAVIS_REPO_SLUG:$1 diff --git a/travis/docs.sh b/travis/docs.sh new file mode 100755 index 0000000..1f7ea32 --- /dev/null +++ b/travis/docs.sh @@ -0,0 +1,36 @@ +#!/usr/bin/env bash + +set -e +TAGNAME=$1 +GH_REF=github.com/aerokube/selenoid.git +git config user.name "${TRAVIS_REPO_SLUG}" +git config user.email "aerokube@aerokube.github.com" +git remote add upstream "https://${GITHUB_TOKEN}@${GH_REF}" +git fetch upstream + +git branch -r + +echo "Deleting old output" +rm -rf ${TRAVIS_BUILD_DIR}/docs/output +mkdir ${TRAVIS_BUILD_DIR}/docs/output +git worktree prune +rm -rf ${TRAVIS_BUILD_DIR}/.git/worktrees/docs/output/ + +echo "Checking out gh-pages branch into docs/output" +git worktree add -B gh-pages ${TRAVIS_BUILD_DIR}/docs/output upstream/gh-pages + +echo "Removing existing files" +mkdir -p ${TRAVIS_BUILD_DIR}/docs/output/${TAGNAME} +rm -rf ${TRAVIS_BUILD_DIR}/docs/output/${TAGNAME}/* + +#echo "Copying images" +#cp -R ${TRAVIS_BUILD_DIR}/docs/img ${TRAVIS_BUILD_DIR}/docs/output/${TAGNAME}/img +echo "Generating docs" +docker run -v ${TRAVIS_BUILD_DIR}/docs/:/documents/ --name asciidoc-to-html asciidoctor/docker-asciidoctor asciidoctor -a revnumber=${TAGNAME} -D /documents/output/${TAGNAME} index.adoc + + +echo "Updating gh-pages branch" +cd ${TRAVIS_BUILD_DIR}/docs/output && git add --all && git commit -m "Publishing to gh-pages" + + +git push upstream HEAD:gh-pages