60 lines (44 loc) · 2.72 KB

Internal Notes to the Shakacode Team

Deployment

Deployments are handled by Control Plane configuration in this repo and GitHub Actions.

Review Apps

Add a comment /deploy-review-app to any PR to deploy a review app
The generated app name is ${REVIEW_APP_PREFIX}-${PR_NUMBER}. Keep REVIEW_APP_PREFIX set to qa-react-webpack-rails-tutorial-pr so review apps use names like qa-react-webpack-rails-tutorial-pr-1234, matching the prefix-backed config in .controlplane/controlplane.yml.
New pushes to a PR redeploy only after the review app already exists.
Add /delete-review-app to delete a review app manually; closing the PR also deletes it automatically.

Staging Environment

Automatic: Any merge to the master branch automatically deploys to staging
URLs:
- Control Plane Console - Staging
- Staging App

Production Environment

Manual: Run the cpflow-promote-staging-to-production workflow on GitHub
URLs:
- Control Plane Console - Production
- Production App

GitHub Repository Settings

Required repository secrets:

CPLN_TOKEN_STAGING
CPLN_TOKEN_PRODUCTION

Required repository variables:

CPLN_ORG_STAGING=shakacode-open-source-examples-staging
CPLN_ORG_PRODUCTION=shakacode-open-source-examples-production
STAGING_APP_NAME=react-webpack-rails-tutorial-staging
PRODUCTION_APP_NAME=react-webpack-rails-tutorial-production
REVIEW_APP_PREFIX=qa-react-webpack-rails-tutorial-pr
STAGING_APP_BRANCH=master
PRIMARY_WORKLOAD=rails

Optional repository settings:

DOCKER_BUILD_SSH_KEY: secret for private SSH dependencies during Docker builds.
DOCKER_BUILD_EXTRA_ARGS: newline-delimited Docker build tokens, such as --build-arg=FOO=bar.
DOCKER_BUILD_SSH_KNOWN_HOSTS: custom known_hosts entries when SSH build hosts are not GitHub.com.

If staging moves off master, update both STAGING_APP_BRANCH and the branch filter in .github/workflows/cpflow-deploy-staging.yml.

See readme.md for more details.

Links