-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1409 from virtualcell/help-generate-docs
Help generate docs
- Loading branch information
Showing
5 changed files
with
177 additions
and
177 deletions.
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
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,60 @@ | ||
| name: webhelp-deploy.yml | ||
| on: | ||
| workflow_dispatch: | ||
| jobs: | ||
| deploy: | ||
| name: Deploy Web Help Documentation | ||
| runs-on: ubuntu-20.04 | ||
| steps: | ||
| - name: checkout tag | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: setup global environment variables | ||
| run: | | ||
| echo "VCELL_REPO_NAMESPACE=ghcr.io/virtualcell" >> $GITHUB_ENV | ||
| echo "VCELL_DEPLOY_REMOTE_DIR=/share/apps/vcell3/deployed_github" >> $GITHUB_ENV | ||
| echo "VCELL_WEBHELP_REMOTE_DIR=/share/apps/vcell3/apache_webroot/htdocs/webstart/VCell_Tutorials/VCell_Help" >> $GITHUB_ENV | ||
| echo "VCELL_MANAGER_NODE=vcellapi.cam.uchc.edu" >> $GITHUB_ENV | ||
| - name: setup ssh-agent | ||
| uses: webfactory/ssh-agent@v0.8.0 | ||
| with: | ||
| ssh-private-key: ${{ secrets.VC_KEY }} | ||
|
|
||
| - name: setup java 17 with maven cache (for documentation build) | ||
| uses: actions/setup-java@v4 | ||
| with: | ||
| distribution: 'temurin' | ||
| java-version: '17' | ||
| cache: 'maven' | ||
|
|
||
| - name: build documentation for web help | ||
| run: | | ||
| mvn clean install -DskipTests | ||
| - name: Deploy Web Help | ||
| run: | | ||
| set -ux | ||
| webhelp_local_dir="~/work/vcell/vcell/vcell-client/target/classes/vcellDoc" | ||
| ssh_user=${{ secrets.CD_FULL_USER }} | ||
| webhelp_deploy_dir="${VCELL_WEBHELP_REMOTE_DIR}" | ||
| manager_node="${VCELL_MANAGER_NODE}" | ||
| if [[ -z "${webhelp_deploy_dir}" || -z "${manager_node}" ]]; then | ||
| echo "Error: VCELL_WEBHELP_REMOTE_DIR or manager_node is not set." | ||
| exit 1; | ||
| fi | ||
| if ! rsync -a -vvv "${webhelp_local_dir}/topics" "$ssh_user@$manager_node:${webhelp_deploy_dir}"; | ||
| then | ||
| echo "failed to copy html files in topic directory to webhelp deploy directory"; | ||
| fi | ||
| if ! scp "${webhelp_local_dir}/VCellHelpTOC.html" "$ssh_user@$manager_node:${webhelp_deploy_dir}/index.html"; | ||
| then | ||
| echo "failed to index.html to webhelp deploy directory"; | ||
| fi | ||
| - name: Setup tmate session 3 | ||
| uses: mxschmitt/action-tmate@v3 | ||
| if: ${{ failure() }} | ||
| with: | ||
| limit-access-to-actor: false | ||
|
|
This file was deleted.
Oops, something went wrong.
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,113 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -ux | ||
|
|
||
| show_help() { | ||
| echo "Deploys vcell client installers." | ||
| echo "" | ||
| echo "usage: deploy-installers.sh [OPTIONS] REQUIRED-ARGUMENTS" | ||
| echo "" | ||
| echo " REQUIRED-ARGUMENTS" | ||
| echo " manager-node any node for ssh access (e.g. vcellapi.cam.uchc.edu)" | ||
| echo "" | ||
| echo " local-config-file local config file for setting environment" | ||
| echo "" | ||
| echo " [OPTIONS]" | ||
| echo " -h | --help show this message" | ||
| echo "" | ||
| echo " --ssh-user user user for ssh to node [defaults to current user id using whoami]" | ||
| echo " (user must have passwordless sudo for docker commands on manager-node)" | ||
| echo "" | ||
| echo " --installer-deploy-dir /path/to/installer/dir" | ||
| echo " directory for installers accessible to users" | ||
| echo " typically a web-accessible location to download the client installers for each platform" | ||
| echo "" | ||
| echo "" | ||
| echo "" | ||
| echo "example:" | ||
| echo "" | ||
| echo "deploy-installers.sh \\" | ||
| echo " --ssh-user vcell \\" | ||
| echo " --installer_deploy_dir /share/apps/vcell3/apache_webroot/htdocs/webstart/Alpha \\" | ||
| echo " vcellapi.cam.uchc.edu \\" | ||
| echo " ./server.config" | ||
| exit 1 | ||
| } | ||
|
|
||
| if [[ $# -lt 2 ]]; then | ||
| show_help | ||
| fi | ||
|
|
||
| ssh_user=$(whoami) | ||
| installer_deploy_dir= | ||
| while :; do | ||
| case $1 in | ||
| -h|--help) | ||
| show_help | ||
| exit | ||
| ;; | ||
| --ssh-user) | ||
| shift | ||
| ssh_user=$1 | ||
| ;; | ||
| --installer-deploy-dir) | ||
| shift | ||
| installer_deploy_dir=$1 | ||
| ;; | ||
| -?*) | ||
| printf 'ERROR: Unknown option: %s\n' "$1" >&2 | ||
| echo "" | ||
| show_help | ||
| ;; | ||
| *) # Default case: No more options, so break out of the loop. | ||
| break | ||
| esac | ||
| shift | ||
| done | ||
|
|
||
| if [[ $# -ne 2 ]] ; then | ||
| show_help | ||
| fi | ||
|
|
||
| manager_node=$1 | ||
| local_config_file=$2 | ||
|
|
||
| # get settings from config file | ||
| vcell_siteCamel=$(grep VCELL_SITE_CAMEL "$local_config_file" | cut -d"=" -f2) | ||
| vcell_version=$(grep VCELL_VERSION_NUMBER "$local_config_file" | cut -d"=" -f2) | ||
| vcell_build=$(grep VCELL_BUILD_NUMBER "$local_config_file" | cut -d"=" -f2) | ||
|
|
||
|
|
||
| # | ||
| # if --installer-deploy-dir, then copy the installers from ./generated_installers directory to the installer deploy directory | ||
| # | ||
| if [ ! -z "$installer_deploy_dir" ]; then | ||
| # vcell_siteCamel=Alpha | ||
| # vcell_version=7.0.0 | ||
| # vcell_build=19 | ||
| # version=7_0_0_19 | ||
| version=$(echo "${vcell_version}_${vcell_build}" | tr '.' _) | ||
| if ! scp "./generated_installers/VCell_${vcell_siteCamel}_windows-x64_${version}_64bit.exe" \ | ||
| "./generated_installers/VCell_${vcell_siteCamel}_unix_${version}_32bit.sh" \ | ||
| "./generated_installers/VCell_${vcell_siteCamel}_macos_${version}_64bit.dmg" \ | ||
| "./generated_installers/VCell_${vcell_siteCamel}_windows-x32_${version}_32bit.exe" \ | ||
| "./generated_installers/VCell_${vcell_siteCamel}_unix_${version}_64bit.sh" \ | ||
| "./generated_installers/updates.xml" \ | ||
| "./generated_installers/updates_linux32.xml" \ | ||
| "./generated_installers/updates_linux64.xml" \ | ||
| "./generated_installers/updates_mac64.xml" \ | ||
| "./generated_installers/updates_win32.xml" \ | ||
| "./generated_installers/updates_win64.xml" \ | ||
| "./generated_installers/output.txt" \ | ||
| "./generated_installers/md5sums" \ | ||
| "./generated_installers/sha256sums" \ | ||
| "$ssh_user@$manager_node:${installer_deploy_dir}"; | ||
| then | ||
| echo "failed to copy installers"; | ||
| exit 1; | ||
| fi | ||
| fi | ||
|
|
||
| echo "exited normally" | ||
|
|
||
| exit 0 |
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