Skip to content

Production deploy workflow and update documentations.#96

Merged
wpak-ai merged 1 commit into
cppalliance:developfrom
AuraMindNest:feature/production-deploy-workflow
Jun 4, 2026
Merged

Production deploy workflow and update documentations.#96
wpak-ai merged 1 commit into
cppalliance:developfrom
AuraMindNest:feature/production-deploy-workflow

Conversation

@AuraMindNest
Copy link
Copy Markdown
Collaborator

@AuraMindNest AuraMindNest commented Jun 4, 2026

Close #76, close #79.

Summary by CodeRabbit

  • Documentation

    • Expanded CI/CD and deployment documentation with environment configurations, rate limiting details, promotion procedures, and troubleshooting guidance.
  • CI/CD Improvements

    • CD workflow now dynamically deploys to staging or production based on branch.
    • Added new workflow for promoting changes from develop to production.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 4, 2026

Review Change Stack

Warning

Review limit reached

@AuraMindNest, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 49 minutes and 25 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9738d3ff-f19e-4637-81fe-87ae501e6e55

📥 Commits

Reviewing files that changed from the base of the PR and between d3531c4 and a473058.

📒 Files selected for processing (5)
  • .github/README.md
  • .github/workflows/cd.yml
  • .github/workflows/promote-main.yml
  • README.md
  • docs/deployment-runbook.md
📝 Walkthrough

Walkthrough

This PR extends the CI/CD deployment infrastructure to support production promotion and multi-environment deployment. A new manual workflow (promote-main.yml) enables fast-forward-only merges from develop to main using a PAT. The updated cd.yml now deploys to both staging (from develop) and production (from main) environments, selecting the target dynamically and deploying the appropriate branch via parameterized SSH scripts. Comprehensive documentation updates cover workflow mechanics, operational procedures, and API reference.

Changes

CI/CD Deployment Enhancement

Layer / File(s) Summary
Production Promotion Workflow
.github/workflows/promote-main.yml
New workflow Promote develop to main triggers manually, checks out main using a PAT, fast-forwards it to origin/develop, and pushes the result. Concurrency configured to allow overlapping runs.
Multi-Branch CD Deployment
.github/workflows/cd.yml
Updated trigger to listen for CI completion on both main and develop branches. Job selects production environment for main, staging for develop. SSH deployment script now uses $BRANCH env var to deploy the appropriate branch with dynamic git operations (fetch, checkout, pull). SSH port defaults to 22 if not specified.
Workflow Documentation
.github/README.md
Workflows table now documents cd.yml as deploying to staging (develop) and production (main). Added promote-main.yml entry explaining ff-only merge and PROMOTE_PAT requirement. Expanded deployment section covers environment/branch mapping and required secrets.
Deployment Runbook
docs/deployment-runbook.md
New "Automated CD Flow" section explains cd.yml behavior post-CI with SSH-based deployment steps, Docker build/health polling, and failure log dump. Added branch-to-environment mapping, production promotion workflow details, GitHub secrets per environment, rollback procedures (both production and staging), and CD failure modes table. Documented why PROMOTE_PAT is required and what causes ff-only merge failures.
User Documentation
README.md
Added "Docker (CD / staging and production)" section pointing to deployment runbook. Updated architecture diagram label from AppConfig.ready() to AppConfig ready. Extended Boost endpoint routes table with rate-limiting scopes and 429 behavior. New "Rate Limiting" section documents DRF throttling configuration, default rates, env var overrides, and Retry-After handling. Revised CI/CD pipeline overview to reflect eight reusable workflows (adding weblate-pin) and clarified promotion/deploy flow. Expanded environment & config reference table with CD, Boost, Weblate, and workflow documentation topics.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

  • henry0816191
  • wpak-ai

🐰 A hop, a skip, a merge so fine,
Now develop flows to main's design!
Two environments, one smooth flow,
Production blooms where pipelines go!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately captures the main objective of the PR: implementing a production deployment workflow (promote-main.yml and cd.yml updates) and updating related documentation across multiple files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@AuraMindNest
Copy link
Copy Markdown
Collaborator Author

@coderabbitai full review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 4, 2026

✅ Action performed

Full review finished.

@AuraMindNest AuraMindNest requested a review from henry0816191 June 4, 2026 16:55
@henry0816191 henry0816191 requested a review from wpak-ai June 4, 2026 18:55
@wpak-ai wpak-ai merged commit 49fe1fb into cppalliance:develop Jun 4, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update documentation Production deploy workflow

3 participants