Skip to content

Public CPROVER documentation [TG-2181] #1951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,24 @@ jobs:
env: NAME="DOXYGEN-CHECK"
addons:
apt:
sources:
- sourceline: 'deb http://packages.cloud.google.com/apt cloud-sdk-trusty main'
key_url: 'https://packages.cloud.google.com/apt/doc/apt-key.gpg'
packages:
- doxygen
- google-cloud-sdk
install:
script: scripts/travis_doxygen.sh
before_cache:
after_success:
# Google Cloud Integration
- export BRANCH="${TRAVIS_PULL_REQUEST_BRANCH:-$TRAVIS_BRANCH}"
- openssl aes-256-cbc -k ${GCLOUD_TRAVIS_CBMC_KEY}
-in gcloud-travis-cbmc.json.enc -out gcloud-travis-cbmc.json -d
- export G_KEY=${PWD}/gcloud-travis-cbmc.json
- gcloud auth activate-service-account --key-file ${G_KEY}

- scripts/publish_doc.sh

# Ubuntu Linux with glibc using g++-5
- stage: Linter + Doxygen + non-debug Ubuntu/gcc-5 test
Expand Down
Binary file added gcloud-travis-cbmc.json.enc
Binary file not shown.
37 changes: 37 additions & 0 deletions scripts/publish_doc.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#! /usr/bin/env bash

# Copy doc/html to Google Cloud bucket cprover.diffblue.com

set -euo pipefail


#### Variables

#User-defined variables
DOCS_FQDN="cprover.diffblue.com"
DOCS_GS="gs://${DOCS_FQDN}"

# Path to generated HTML documentation
DOCS_PATH="$(dirname "$(readlink -f "$0")")/../doc/html"

# Colors for nice output
GREEN='\033[0;32m'
#RED='\033[0;31m'
NC='\033[0m' # No Color


#### Deployments

# For develop branch
if [[ "${BRANCH:-null}" == "develop" ]]; then

echo -e "\n${GREEN}Uploading ${DOCS_FQDN}${NC}\n"
# Copy HTML docs to gcloud
gsutil -m -h "Cache-Control:public,max-age=60" \
rsync -r -d -c "${DOCS_PATH}" "${DOCS_GS}/"
echo -e "\n${GREEN}${DOCS_FQDN} is live${NC}\n"

# For all other branches
else
echo -e "\n${GREEN}Nothing to upload in >>${BRANCH}<< branch.${NC}\n"
fi