Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document the staging deployment setup #423

Merged
merged 1 commit into from
Nov 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,19 @@ For details on how this actions is configured see:
- https://aws.amazon.com/blogs/security/use-iam-roles-to-connect-github-actions-to-actions-in-aws/
- https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services

### Deploying to the staging environment

The project has a staging environment at [https://connect-staging.dimagi.com/](https://connect-staging.dimagi.com/),
which is connected to the staging environment of CommCare HQ at
[https://staging.commcarehq.org/](https://staging.commcarehq.org/).

By convention, the `pkv/staging` branch is used for changes that are on the staging environment.
To put your own changes on the staging environment, you can create merge your own branch into
`pkv/staging` and then push it to GitHub.

After that, you can deploy to the staging environment by manually running the `deploy`
[workflow from here](https://github.com/dimagi/commcare-connect/actions/workflows/deploy.yml).

### Custom Bootstrap Compilation

The generated CSS is set up with automatic Bootstrap recompilation with variables of your choice.
Expand Down
Loading