[Ekhorn]

Description

Documents what each environment workflow handles and how the deployment workflow resolves its configuration, in the workflow header comments. Related to openremote/documentation#171; merge that first, since AGENTS.md links its published page. Problems in the workflows found during review are tracked in #3474.

Changelog

• Add header comments to the review, staging and deploy workflows and their custom project counterparts
• Document how deployment.yml selects deployments and combines secrets, inputs and env files
• Fix the job list in the deploy.yml header
• Fix the variable precedence and remove the unsupported SSH_PASSWORD in the ci_cd.yml header and .ci_cd/README.md
• Point .ci_cd/README.md at the current workflows
• Link the CI/CD pipeline guide in AGENTS.md

Checklist

• 1. Acceptance criteria of the linked issue(s) are met
• 2. Tests are written and all tests pass
• 3. Changes are manually tested by you and the reviewer
• 4. Documentation is written or updated

[MartinaeyNL]

Initial review by an AI agent

Thanks! The header comments are excellent — I traced the deployment.yml and deploy.yml ones back through deploy.sh, process-cicd-json and Do deployments, and the precedence / secret-handling / env-file claims all check out.

One thing before merge: the diff isn't only comments. custom-staging.yml now deploys, custom-install-dist.yml and custom-deploy.yml are new workflows, and custom-review.yml / custom-staging.yml switch build workflows — none of which is in the changelog. Two commits are also still called wip.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud