xref: /expo/docs/deploy.sh (revision f7a14300)

#!/usr/bin/env bash

set -euo pipefail

scriptdir=$(dirname "${BASH_SOURCE[0]}")
bucket="$AWS_BUCKET"
target="${1-$scriptdir/out}"

if [ ! -d "$target" ]; then
  echo "target $target not found"
  exit 1
fi


# To keep the previous website up and running, we deploy it using these steps.
#   1.  Sync Next.js static assets in \`_next/**\` folder
#      > Uploads the new generated JS and asset files (stored in hashed folders to avoid collision with older deployments)
#   2.  Sync assets in \`static/**\` folder
#   3. Overwrite HTML dependents, not located in \`_next/**\` or \`static/**\` folder
#      > Force overwrite of all HTML files to make sure we use the latest one
#   4. Sync assets and clean up outdated files from previous deployments
#   5. Add custom redirects
#   6. Notify Google of sitemap changes for SEO

echo "::group::[1/6] Sync Next.js static assets in \`_next/**\` folder"
aws s3 sync \
  --no-progress \
  --exclude "*" \
  --include "_next/**" \
  --cache-control "public, max-age=31536000, immutable" \
  "$target" \
  "s3://${bucket}"
echo "::endgroup::"

echo "::group::[2/6] Sync assets in \`static/**\` folder"
aws s3 sync \
  --no-progress \
  --exclude "*" \
  --include "static/**" \
  --cache-control "public, max-age=3600" \
  "$target" \
  "s3://${bucket}"
echo "::endgroup::"

# Due to a bug with `aws s3 sync` we need to copy everything first instead of syncing
# see: https://github.com/aws/aws-cli/issues/3273#issuecomment-643436849
echo "::group::[3/6] Overwrite HTML dependents, not located in \`_next/**\` or \`static/**\` folder"
aws s3 cp \
  --no-progress \
  --recursive \
  --exclude "_next/**" \
  --exclude "static/**" \
  "$target" \
  "s3://${bucket}"
echo "::endgroup::"

echo "::group::[4/6] Sync assets and clean up outdated files from previous deployments"
aws s3 sync \
  --no-progress \
  --delete \
  "$target" \
  "s3://${bucket}"
echo "::endgroup::"

declare -A redirects # associative array variable

# usage:
# redirects[requests/for/this/path]=are/redirected/to/this/one

# Temporarily create a redirect for a page that Home links to
redirects[versions/latest/introduction/installation.html]=versions/latest/introduction/installation/
# useful link on twitter
redirects[versions/latest/guides/app-stores.html]=versions/latest/distribution/app-stores/
# Xdl caches
redirects[versions/latest/guides/offline-support.html]=versions/latest/guides/offline-support/
# xdl convert comment
redirects[versions/latest/sdk/index.html]=versions/latest/sdk/overview/
# upgrading expo -> upgrading sdk walkthrough
redirects[versions/latest/workflow/upgrading-expo]=versions/latest/workflow/upgrading-expo-sdk-walkthrough/
# rename
redirects[versions/latest/sdk/haptic/index.html]=versions/latest/sdk/haptics/
redirects[development/eas-build]=development/build
# duplicate docs file, consolidate into one page
redirects[versions/latest/sdk/introduction/index.html]=versions/latest/sdk/overview/
# project-lifecycle is now covered by managed-vs-bare
redirects[versions/latest/introduction/project-lifecycle/]=versions/latest/introduction/managed-vs-bare/
# exp-cli is now expo-cli
# redirects[versions/latest/guides/exp-cli.html]=versions/latest/workflow/expo-cli/
# redirects[versions/latest/guides/exp-cli]=versions/latest/workflow/expo-cli/
# Migrated FAQ pages
redirects[faq/image-background]=ui-programming/image-background/
redirects[faq/react-native-styling-buttons]=ui-programming/react-native-styling-buttons/
redirects[faq/react-native-version-mismatch]=troubleshooting/react-native-version-mismatch/
redirects[faq/clear-cache-windows]=troubleshooting/clear-cache-windows/
redirects[faq/clear-cache-macos-linux]=troubleshooting/clear-cache-macos-linux/
redirects[faq/application-has-not-been-registered]=troubleshooting/application-has-not-been-registered/
redirects[distribution/building-standalone-apps]=archive/classic-updates/building-standalone-apps/
redirects[build-reference/build-webhook]=eas/webhooks/
redirects[distribution/webhooks]=eas/webhooks/
redirects[distribution/turtle-cli]=archive/classic-updates/turtle-cli/
redirects[distribution/app-signing]=app-signing/app-credentials/
redirects[guides/adhoc-builds]=archived/adhoc-builds/
# clients is now development
redirects[clients/distribution-for-ios]=development/build/
redirects[clients/distribution-for-android]=development/build/
redirects[clients/compatibility]=development/introduction/
redirects[development/compatibility]=development/introduction/
redirects[clients/development-workflows]=development/development-workflows/
redirects[clients/eas-build]=development/eas-build/
redirects[clients/extending-the-dev-menu]=development/extending-the-dev-menu/
redirects[clients/getting-started]=development/getting-started/
redirects[clients/installation]=development/installation/
redirects[clients/introduction]=development/introduction/
redirects[clients/troubleshooting]=development/troubleshooting/
redirects[clients/upgrading]=development/upgrading/
# Expo Modules
redirects[modules]=modules/overview/
redirects[module-api]=modules/module-api/
redirects[module-config]=modules/module-config/
# EAS Metadata
redirects[eas-metadata]=eas/metadata/
redirects[eas-metadata/introduction]=eas/metadata/
redirects[eas-metadata/getting-started]=eas/metadata/getting-started/
# EAS Build
redirects[build-reference/eas-json]=eas/json/#eas-build

# Development builds
redirects[development/build]=development/create-development-builds/
redirects[development/getting-started]=development/create-development-builds/
redirects[development/troubleshooting]=development/introduction/
redirects[development/upgrading]=development/introduction/
redirects[development/extensions]=development/development-workflows/
redirects[development/develop-your-project]=development/use-development-builds/

# Guides that have been deleted
redirects[guides/using-gatsby]=/
redirects[guides/testing-on-devices]=workflow/run-on-device
redirects[distribution/uploading-apps]=submit/introduction
redirects[guides/setup-native-firebase/]=guides/using-firebase
redirects[guides/using-clojurescript/]=/
redirects[distribution/hosting-your-app/]=distribution/publishing-websites/

# We should change this redirect to a more general EAS guide later
redirects[guides/setting-up-continuous-integration]=build/building-on-ci

# Moved classic updates
redirects[distribution/release-channels]=archive/classic-updates/release-channels
redirects[distribution/advanced-release-channels]=archive/classic-updates/advanced-release-channels
redirects[distribution/optimizing-updates]=archive/classic-updates/optimizing-updates
redirects[eas-update/custom-updates-server]=distribution/custom-updates-server
redirects[guides/offline-support]=archive/classic-updates/offline-support
redirects[guides/preloading-and-caching-assets]=archive/classic-updates/preloading-and-caching-assets
redirects[guides/configuring-updates]=archive/classic-updates/configuring-updates
redirects[eas-update/bare-react-native]=bare/updating-your-app
redirects[worfkflow/publishing]=archive/classic-updates/publishing
redirects[classic/building-standalone-apps/]=archive/classic-updates/building-standalone-apps/
redirects[classic/turtle-cli/]=archive/classic-updates/turtle-cli/
redirects[archive/classic-updates/getting-started/]=eas-update/getting-started/
redirects[archived/]=archive/

# Old tutorial pages
redirects[introduction/walkthrough]=tutorial/introduction/
redirects[tutorial/planning]=tutorial/introduction/
redirects[tutorial/sharing]=tutorial/introduction/
redirects[tutorial/text]=tutorial/introduction/

# EAS Update
redirects[technical-specs/expo-updates-0/]=archive/technical-specs/expo-updates-0/
redirects[eas-update/developing-with-eas-update/]=eas-update/develop-faster/
redirects[eas-update/eas-update-with-local-build/]=eas-update/build-locally/
redirects[eas-update/eas-update-and-eas-cli/]=eas-update/eas-cli/
redirects[eas-update/debug-updates/]=eas-update/debug/
redirects[eas-update/how-eas-update-works/]=eas-update/how-it-works/
redirects[eas-update/migrate-to-eas-update/]=eas-update/migrate-from-classic-updates/

# Removed API reference docs
redirects[versions/latest/sdk/facebook]=guides/authentication/
redirects[versions/latest/sdk/taskmanager]=versions/latest/sdk/task-manager/
redirects[versions/latest/sdk/videothumbnails]=versions/latest/sdk/video-thumbnails/
redirects[versions/latest/sdk/appearance]=versions/latest/react-native/appearance/
redirects[versions/latest/sdk/app-loading]=versions/latest/sdk/splash-screen/
redirects[versions/latest/sdk/app-auth]=guides/authentication/
redirects[versions/latest/sdk/firebase-core]=guides/using-firebase/
redirects[versions/latest/sdk/firebase-analytics]=guides/using-firebase/
redirects[versions/latest/sdk/firebase-recaptcha]=guides/using-firebase/
redirects[versions/latest/sdk/google-sign-in]=guides/authentication/
redirects[versions/latest/sdk/google]=guides/authentication/
redirects[versions/latest/sdk/amplitude/]=guides/using-analytics/
redirects[versions/latest/sdk/util/]=versions/latest/

# Redirects based on Sentry reports
redirects[push-notifications]=push-notifications/overview/

echo "::group::[5/6] Add custom redirects"
for i in "${!redirects[@]}" # iterate over keys
do
  aws s3 cp \
    --no-progress \
    --metadata-directive REPLACE \
    --website-redirect "/${redirects[$i]}" \
    "$target/404.html" \
    "s3://${bucket}/${i}"

  # Also add redirects for paths without `.html` or `/`
  # S3 translates URLs with trailing slashes to `path/` -> `path/index.html`
  if [[ $i != *".html" ]] && [[ $i != *"/" ]]; then
    aws s3 cp \
      --no-progress \
      --metadata-directive REPLACE \
      --website-redirect "/${redirects[$i]}" \
      "$target/404.html" \
      "s3://${bucket}/${i}/index.html"
  fi
done
echo "::endgroup::"


if [ "$bucket" = "docs.expo.dev" ]; then
  echo "::group::[6/6] Notify Google of sitemap changes"
  curl -m 15 "https://www.google.com/ping\?sitemap\=https%3A%2F%2F${bucket}%2Fsitemap.xml"
  echo "\n::endgroup::"
fi