feat: add stage deployment configuration and update README with staging details

[konradmichalik]

Summary by CodeRabbit

• New Features

  • Automated deployment to staging environment now available through the CI/CD pipeline, with branch-based rules and dependency management.

• Documentation

  • Added documentation covering staging deployment setup and available configuration options.

[coderabbitai]

📝 Walkthrough

Walkthrough

Introduces a new staging deployment job for GitLab CI pipelines and supporting documentation. The changes add a deploy:stage job that manages deployments to a staging environment via Deployer, triggered on the main branch after successful PHP and Node.js builds.

Changes

Cohort / File(s)	Summary
Documentation README.md	Adds a new "Stage Deployment" section describing staging deployment configuration, template reference (deploy/deploy-stage.yaml), and deployment strategy notes.
CI Configuration deploy/deploy-stage.yaml	Introduces a new GitLab CI job deploy:stage that executes staging deployments via Deployer, with dependencies on build:php and build:node, targeting the main branch.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Hop along, the stage is set!
New pipelines, no regrets—
Main branch builds, then deploys with flair,
Staging's ready, fresh and fair! 🚀

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main changes: adding a stage deployment configuration file (deploy-stage.yaml) and updating the README with staging deployment documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch deploy-stage

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

🧹 Nitpick comments (1)

README.md (1)

96-101: Document required stage deployment variables in this section.

This section lists the template, but not the minimum variables needed to use it (SSH_USER_STAGE, SSH_HOST_STAGE). Adding them here will prevent setup friction.

Proposed README addition

 Includes:
 - `deploy/deploy-stage.yaml`
+
+Required CI/CD variables:
+- `SSH_USER_STAGE`
+- `SSH_HOST_STAGE`
+
+Optional variables:
+- `STAGE_TARGET_BRANCH` (default: `main`)
+- `DEPLOYER_CONFIG_ADDITIONAL_OPTION`

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 96 - 101, The README mentions the stage deployment
template (deploy/deploy-stage.yaml) but omits the required environment
variables; update the "Includes: - `deploy/deploy-stage.yaml`" section to
document the minimum variables `SSH_USER_STAGE` and `SSH_HOST_STAGE` (and any
other required vars used by deploy/deploy-stage.yaml), showing their names and a
short description/example value so users can run the stage deployment without
friction.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Around line 96-101: The README mentions the stage deployment template
(deploy/deploy-stage.yaml) but omits the required environment variables; update
the "Includes: - `deploy/deploy-stage.yaml`" section to document the minimum
variables `SSH_USER_STAGE` and `SSH_HOST_STAGE` (and any other required vars
used by deploy/deploy-stage.yaml), showing their names and a short
description/example value so users can run the stage deployment without
friction.

---

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 915d3aa and 2cad93e.

📒 Files selected for processing (2)

• README.md
• deploy/deploy-stage.yaml