Skip to content

shakacode-team.md

Latest commit

 

History

History
76 lines (58 loc) · 3.91 KB

shakacode-team.md

File metadata and controls

76 lines (58 loc) · 3.91 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

Production Environment

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.
  • CPLN_CLI_VERSION: pin a specific @controlplane/cli version; defaults to the generated action pin.
  • CPFLOW_VERSION: pin a specific cpflow gem version; defaults to the generated action pin.
  • HEALTH_CHECK_ACCEPTED_STATUSES: production promotion health statuses; defaults to 200 301 302.
  • HEALTH_CHECK_RETRIES / HEALTH_CHECK_INTERVAL: production health polling controls; defaults to 24 retries and 15 seconds.
  • ROLLBACK_READINESS_RETRIES / ROLLBACK_READINESS_INTERVAL: post-rollback health polling controls; defaults to 24 retries and 15 seconds.

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

Keeping cpflow Automation Current

When the upstream control-plane-flow repo changes the generated GitHub Actions flow, regenerate the cpflow-* actions/workflows in this repo from the target cpflow version or branch using --staging-branch master, review the diff, and keep the repository variables above aligned with .controlplane/controlplane.yml. Validate with cpflow github-flow-readiness, actionlint .github/workflows/cpflow-*.yml, and the normal CI checks before merging.

See readme.md for more details.

Links