docs: add documentation comments to JSON schema types #2467
Workflow file for this run
This file contains hidden or 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
| # Build web app and deploy it | |
| name: web | |
| on: | |
| push: | |
| branches: [ 'master', 'staging', 'release' ] | |
| pull_request: | |
| repository_dispatch: | |
| types: build | |
| workflow_dispatch: | |
| workflow_call: | |
| concurrency: | |
| group: web-${{ github.workflow }}-${{ github.ref_type }}-${{ github.event.pull_request.number || github.ref || github.run_id }} | |
| cancel-in-progress: true | |
| defaults: | |
| run: | |
| shell: bash -euxo pipefail {0} | |
| env: | |
| GITHUB_REPOSITORY_URL: ${{ github.server_url }}/${{ github.repository }} | |
| VERBOSE: 1 | |
| jobs: | |
| build-web: | |
| name: "Build Web" | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: "Set up Docker Buildx" | |
| uses: docker/setup-buildx-action@v3 | |
| - name: "Free disk space" | |
| run: | | |
| set -euo pipefail | |
| sudo swapoff -a || true | |
| sudo rm -f /swapfile || true | |
| mapfile -t purge_list < <(dpkg -l | awk ' | |
| /^ii/ { | |
| p=$2 | |
| if (p ~ /^(dotnet-.*|llvm-.*|php.*|mongodb-.*|mysql-.*)$/) print p | |
| }') | |
| sudo apt-get purge -y "${purge_list[@]:-}" azure-cli google-cloud-sdk hhvm google-chrome-stable firefox powershell mono-devel libgl1-mesa-dri || true | |
| sudo apt-get autoremove -y --purge | |
| sudo apt-get clean | |
| sudo rm -rf /var/lib/apt/lists/* | |
| sudo rm -rf \ | |
| /opt/ghc \ | |
| /opt/hostedtoolcache/CodeQL \ | |
| /usr/local/.ghcup \ | |
| /usr/local/graalvm \ | |
| /usr/local/lib/android \ | |
| /usr/local/share/chromium \ | |
| /usr/local/share/powershell \ | |
| /usr/share/dotnet \ | |
| ~/.cache/* | |
| docker ps -q | xargs -r docker stop || true | |
| docker system prune -af --volumes || true | |
| docker builder prune -af || true | |
| docker buildx prune -af || true | |
| - name: "Check disk space" | |
| run: | | |
| echo "" | |
| df -Th | awk 'NR == 1; NR > 1 {print $0 | "sort -n"}' | |
| echo "" | |
| lsblk -o MOUNTPOINT,FSTYPE,FSSIZE,FSAVAIL,FSUSE%,TYPE,NAME,ROTA,SIZE,MODEL,UUID | |
| - name: "Setup environment (release)" | |
| if: endsWith(github.ref, '/release') | |
| run: | | |
| echo "ENV_NAME=release" >> $GITHUB_ENV | |
| echo "FULL_DOMAIN=https://clades.nextstrain.org" >> $GITHUB_ENV | |
| echo "DATA_FULL_DOMAIN=https://data.clades.nextstrain.org/v3" >> $GITHUB_ENV | |
| echo "PLAUSIBLE_IO_DOMAIN=clades.nextstrain.org" >> $GITHUB_ENV | |
| - name: "Setup environment (staging)" | |
| if: endsWith(github.ref, '/staging') | |
| run: | | |
| echo "ENV_NAME=staging" >> $GITHUB_ENV | |
| echo "FULL_DOMAIN=https://staging.clades.nextstrain.org" >> $GITHUB_ENV | |
| echo "DATA_FULL_DOMAIN=https://data.staging.clades.nextstrain.org/v3" >> $GITHUB_ENV | |
| echo "PLAUSIBLE_IO_DOMAIN=staging.clades.nextstrain.org" >> $GITHUB_ENV | |
| - name: "Setup environment (master)" | |
| if: ${{ !endsWith(github.ref, '/staging') && !endsWith(github.ref, '/release') }} | |
| run: | | |
| echo "ENV_NAME=master" >> $GITHUB_ENV | |
| echo "FULL_DOMAIN=https://master.clades.nextstrain.org" >> $GITHUB_ENV | |
| echo "DATA_FULL_DOMAIN=https://data.master.clades.nextstrain.org/v3" >> $GITHUB_ENV | |
| echo "PLAUSIBLE_IO_DOMAIN=master.clades.nextstrain.org" >> $GITHUB_ENV | |
| - name: "Checkout code" | |
| uses: actions/checkout@v5 | |
| with: | |
| fetch-depth: 1 | |
| submodules: true | |
| - name: "Get docker build checksum" | |
| id: docker-build-checksum | |
| run: echo "checksum=$(./scripts/docker_build_checksum.sh)" >> $GITHUB_OUTPUT | |
| - name: "Setup cache for Docker buildx" | |
| uses: actions/cache@v4 | |
| with: | |
| path: .cache/docker/buildx | |
| key: cache-v1-buildx-${{ runner.os }}-wasm32-unknown-unknown-${{ steps.docker-build-checksum.outputs.checksum }} | |
| restore-keys: | | |
| cache-v1-buildx-${{ runner.os }}-wasm32-unknown-unknown-${{ steps.docker-build-checksum.outputs.checksum }} | |
| cache-v1-buildx-${{ runner.os }}-wasm32-unknown-unknown- | |
| cache-v1-buildx-${{ runner.os }}-${{ steps.docker-build-checksum.outputs.checksum }} | |
| cache-v1-buildx-${{ runner.os }}- | |
| - name: "Setup cache for Rust and Cargo" | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| .build/ | |
| .cache/docker/.cargo | |
| packages/nextclade-web/.build/docker | |
| key: cache-v1-cargo-${{ runner.os }}-wasm32-unknown-unknown-${{ hashFiles('**/Cargo.lock') }} | |
| restore-keys: | | |
| cache-v1-cargo-${{ runner.os }}-wasm32-unknown-unknown-${{ hashFiles('**/Cargo.lock') }} | |
| cache-v1-cargo-${{ runner.os }}-wasm32-unknown-unknown- | |
| cache-v1-cargo-${{ runner.os }}- | |
| - name: "Setup cache for web app" | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| packages/nextclade-web/.build/production/tmp/cache | |
| packages/nextclade-web/.cache | |
| packages/nextclade-web/node_modules | |
| key: cache-v1-web-${{ runner.os }}-wasm32-unknown-unknown-${{ hashFiles('**/bun.lock') }} | |
| restore-keys: | | |
| cache-v1-web-${{ runner.os }}-wasm32-unknown-unknown-${{ hashFiles('**/bun.lock') }} | |
| cache-v1-web-${{ runner.os }}-wasm32-unknown-unknown- | |
| cache-v1-web-${{ runner.os }}- | |
| - name: "Prepare .env file" | |
| run: | | |
| cp .env.example .env | |
| sed -i -e "s|FULL_DOMAIN=autodetect|FULL_DOMAIN=${FULL_DOMAIN}|g" .env | |
| sed -i -e "s|DATA_FULL_DOMAIN=https://data.master.clades.nextstrain.org/v3|DATA_FULL_DOMAIN=${DATA_FULL_DOMAIN}|g" .env | |
| - name: "Login to Docker Hub" | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: docker.io | |
| username: nextstrainbot | |
| password: ${{ secrets.DOCKER_TOKEN }} | |
| - name: "Build docker image" | |
| run: | | |
| CROSS="wasm32-unknown-unknown" ./docker/dev docker-image-build-push | |
| - name: "Install Node.js packages" | |
| run: | | |
| ./docker/dev web bun install | |
| - name: "Build WebAssembly module" | |
| run: | | |
| ./docker/dev wasm-release | |
| - name: "Build web app" | |
| run: | | |
| ./docker/dev web-release | |
| - name: "Lint web app code" | |
| run: | | |
| ./docker/dev web bun lint:ci | |
| - name: "Lint Rust code" | |
| run: | | |
| ./docker/dev lint-ci | |
| - name: "Upload build artifacts" | |
| uses: actions/upload-artifact@v5 | |
| with: | |
| name: out | |
| path: "packages/nextclade-web/.build/production/web" | |
| deploy-web: | |
| name: "Deploy Web" | |
| if: ${{ endsWith(github.ref, '/master') || endsWith(github.ref, '/staging') || endsWith(github.ref, '/release') }} | |
| needs: [ build-web ] | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: "Setup environment (release)" | |
| if: endsWith(github.ref, '/release') | |
| run: | | |
| echo "AWS_ACCESS_KEY_ID=${{ secrets.RELEASE_AWS_ACCESS_KEY_ID }}" >> $GITHUB_ENV | |
| echo "AWS_SECRET_ACCESS_KEY=${{ secrets.RELEASE_AWS_SECRET_ACCESS_KEY }}" >> $GITHUB_ENV | |
| echo "AWS_CLOUDFRONT_DISTRIBUTION_ID=${{ secrets.RELEASE_AWS_CLOUDFRONT_DISTRIBUTION_ID }}" >> $GITHUB_ENV | |
| echo "AWS_DEFAULT_REGION=${{ secrets.RELEASE_AWS_DEFAULT_REGION }}" >> $GITHUB_ENV | |
| echo "AWS_S3_BUCKET=${{ secrets.RELEASE_AWS_S3_BUCKET }}" >> $GITHUB_ENV | |
| - name: "Setup environment (staging)" | |
| if: endsWith(github.ref, '/staging') | |
| run: | | |
| echo "AWS_ACCESS_KEY_ID=${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}" >> $GITHUB_ENV | |
| echo "AWS_SECRET_ACCESS_KEY=${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}" >> $GITHUB_ENV | |
| echo "AWS_CLOUDFRONT_DISTRIBUTION_ID=${{ secrets.STAGING_AWS_CLOUDFRONT_DISTRIBUTION_ID }}" >> $GITHUB_ENV | |
| echo "AWS_DEFAULT_REGION=${{ secrets.STAGING_AWS_DEFAULT_REGION }}" >> $GITHUB_ENV | |
| echo "AWS_S3_BUCKET=${{ secrets.STAGING_AWS_S3_BUCKET }}" >> $GITHUB_ENV | |
| - name: "Setup environment (master)" | |
| if: ${{ !endsWith(github.ref, '/staging') && !endsWith(github.ref, '/release') }} | |
| run: | | |
| echo "AWS_ACCESS_KEY_ID=${{ secrets.MASTER_AWS_ACCESS_KEY_ID }}" >> $GITHUB_ENV | |
| echo "AWS_SECRET_ACCESS_KEY=${{ secrets.MASTER_AWS_SECRET_ACCESS_KEY }}" >> $GITHUB_ENV | |
| echo "AWS_CLOUDFRONT_DISTRIBUTION_ID=${{ secrets.MASTER_AWS_CLOUDFRONT_DISTRIBUTION_ID }}" >> $GITHUB_ENV | |
| echo "AWS_DEFAULT_REGION=${{ secrets.MASTER_AWS_DEFAULT_REGION }}" >> $GITHUB_ENV | |
| echo "AWS_S3_BUCKET=${{ secrets.MASTER_AWS_S3_BUCKET }}" >> $GITHUB_ENV | |
| - name: "Checkout code" | |
| uses: actions/checkout@v5 | |
| with: | |
| fetch-depth: 1 | |
| submodules: true | |
| - name: "Download build artifacts" | |
| uses: actions/download-artifact@v6 | |
| with: | |
| name: "out" | |
| path: "packages/nextclade-web/.build/production/web" | |
| - name: "Install deploy dependencies" | |
| run: | | |
| mkdir -p "${HOME}/bin" | |
| GH_CLI_VERSION=$(./scripts/get-version gh) | |
| curl -fsSL "https://github.com/cli/cli/releases/download/v${GH_CLI_VERSION}/gh_${GH_CLI_VERSION}_linux_amd64.tar.gz" | tar xz -C "${HOME}/bin" --strip-components=2 "gh_${GH_CLI_VERSION}_linux_amd64/bin/gh" | |
| sudo apt-get install brotli pigz parallel rename --yes -qq >/dev/null | |
| pushd /tmp >/dev/null | |
| curl -fsSL "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip" | |
| unzip -oqq awscliv2.zip | |
| sudo ./aws/install --update | |
| popd >/dev/null | |
| aws --version | |
| - name: "Deploy web app" | |
| run: | | |
| ./scripts/deploy_web.sh | |
| - name: "Create and push git tag" | |
| if: ${{ endsWith(github.ref, '/release') }} | |
| run: | | |
| git config user.email "${{ secrets.GIT_USER_EMAIL }}" | |
| git config user.name "${{ secrets.GIT_USER_NAME }}" | |
| pushd packages/nextclade-web >/dev/null | |
| export version=$(node -e "\ | |
| const pkg = require('./package.json'); \ | |
| console.log(pkg.version) \ | |
| ") | |
| popd >/dev/null | |
| git tag "web-${version}" | |
| git push origin "web-${version}" | |
| deploy-preview: | |
| name: "Deploy preview" | |
| runs-on: ubuntu-24.04 | |
| needs: [ build-web ] | |
| steps: | |
| - uses: actions/checkout@v5 | |
| with: | |
| fetch-depth: 1 | |
| submodules: true | |
| - uses: actions/download-artifact@v6 | |
| with: | |
| name: out | |
| path: out | |
| - name: 'deploy' | |
| run: | | |
| args=( | |
| --name "${PREFIX}--commit-${COMMIT::7}" | |
| --name "${PREFIX}--branch-${BRANCH}" | |
| ) | |
| if [[ "${{ github.event_name }}" == "pull_request" ]]; then | |
| args+=(--name "${PREFIX}--pr-${PR_NUM}") | |
| fi | |
| if [[ "${{ github.ref }}" == "refs/heads/release" ]]; then | |
| VERSION=$(jq -r '.version' packages/nextclade-web/package.json) | |
| args+=(--name "${PREFIX}--v${VERSION}") | |
| fi | |
| ./scripts/preview-deploy "${args[@]}" | |
| if [[ "${{ github.event_name }}" == "pull_request" ]]; then | |
| export PREVIEW_URL="https://${PREFIX}--pr-${PR_NUM}.${PREVIEWS_DOMAIN}" | |
| ./scripts/preview-post-pr-comment | |
| fi | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| PREFIX: ${{ github.repository_owner }}--${{ github.event.repository.name }} | |
| COMMIT: ${{ github.sha }} | |
| BRANCH: ${{ github.head_ref || github.ref_name }} | |
| PR_NUM: ${{ github.event.pull_request.number }} | |
| AWS_ACCESS_KEY_ID: ${{ secrets.PREVIEWS_NEHERLAB_CLICK_AWS_ACCESS_KEY_ID }} | |
| AWS_SECRET_ACCESS_KEY: ${{ secrets.PREVIEWS_NEHERLAB_CLICK_AWS_SECRET_ACCESS_KEY }} | |
| AWS_DEFAULT_REGION: ${{ secrets.PREVIEWS_NEHERLAB_CLICK_AWS_DEFAULT_REGION }} | |
| AWS_S3_BUCKET: ${{ secrets.PREVIEWS_NEHERLAB_CLICK_AWS_S3_BUCKET }} | |
| AWS_CLOUDFRONT_DISTRIBUTION_ID: ${{ secrets.PREVIEWS_NEHERLAB_CLICK_AWS_CLOUDFRONT_DISTRIBUTION_ID }} | |
| PREVIEWS_DOMAIN: ${{ vars.PREVIEWS_NEHERLAB_CLICK_DOMAIN }} |