Skip to content

Document CI/CD workflows and point agents to the pipeline guide - #3448

Open
Ekhorn wants to merge 2 commits into
mainfrom
docs/pipeline
Open

Ekhorn wants to merge 2 commits into
mainfrom
docs/pipeline

Conversation

@Ekhorn

@Ekhorn Ekhorn commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

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

@Ekhorn Ekhorn self-assigned this Oct 19, 2026
@Ekhorn Ekhorn changed the title Docs/pipeline Document CI/CD workflows Oct 19, 2026

@MartinaeyNL MartinaeyNL left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread .github/workflows/custom-staging.yml
if: ${{ !failure() && !cancelled() && needs.detect-changes.outputs.deploys != '' }}
uses: "./.github/workflows/deployment.yml"
with:
INPUTS: ${{ inputs.INPUTS }}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ This comment is generated by AI ⚠️

deployment.yml never reads inputs.INPUTS — its Process inputs step only takes callerInputs when eventName == 'workflow_call', which can't happen. What actually feeds it is github.event.inputs, and on a push trigger there are none.

So this passthrough has no effect as written. Either drop it, or fix that guard in deployment.yml so the plumbing is real.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created an issue for this #3474

Comment thread .github/workflows/custom-install-dist.yml
Comment thread .github/workflows/custom-install-dist.yml
Comment thread .github/workflows/deployment.yml
Comment thread .github/workflows/deployment.yml
Comment thread .github/workflows/staging.yml Outdated
Comment thread AGENTS.md Outdated
Comment thread .github/workflows/custom-deploy.yml
type: string

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ This comment is generated by AI ⚠️

github.workflow in a reusable workflow resolves to the caller's workflow name, so this collides with a caller using the same formula by construction — which is what the header warns about. A distinct prefix removes the footgun rather than documenting it.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created an issue for this #3474

@sonarqubecloud

Copy link
Copy Markdown

@Ekhorn
Ekhorn requested a review from a team October 23, 2026 13:49
@Ekhorn
Ekhorn marked this pull request as ready for review October 23, 2026 13:55
@Ekhorn Ekhorn changed the title Document CI/CD workflows Document CI/CD workflows and point agents to the pipeline guide Oct 23, 2026

This branch has not been deployed

No deployments
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.

2 participants