Skip to content

Document CI/CD pipeline - #171

Open
Ekhorn wants to merge 10 commits into
mainfrom
document/pipeline
Open

Ekhorn wants to merge 10 commits into
mainfrom
document/pipeline

Conversation

@Ekhorn

@Ekhorn Ekhorn commented Jun 23, 2026 •

Copy link
Copy Markdown
Contributor

Adds a developer guide page for the CI/CD pipeline of the core repository. It covers the workflows introduced in the pipeline migration (openremote/core#2696) and the custom project workflows (openremote/core#3441).

Structure

  • Overview of the workflows
    • How reusable workflows work
    • Composite actions
  • How the pipeline works
    • Detect changes
    • Handling skipped jobs
    • Special conditions
    • Sharding UI app tests
    • Deployments
  • Custom projects
    • Differences from the core workflows
    • Manual deployments
    • Migrating from ci_cd.yml
  • Making changes to the pipeline
    • Testing changes
    • Writing and updating composite actions
  • Guidelines
    • Gradle vs. workflows
    • Minimal dependency installation
    • Checking out with Git LFS
    • Artifacts
    • File modified metadata tricks
    • Caching
    • Timeouts
    • Secrets

@Ekhorn Ekhorn self-assigned this Jun 23, 2026
Comment thread docs/developer-guide/ci-cd-pipeline.md Outdated
@wborn

wborn commented Jul 20, 2026

Copy link
Copy Markdown
Member

@codex review

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a new developer-guide documentation page describing OpenRemote’s CI/CD pipeline concepts introduced during the pipeline migration referenced in openremote/core#2696, addressing the documentation request in Issue #161.

Changes:

  • Introduces a new CI/CD Pipeline developer-guide page covering pipeline modification/testing, workflow structure, artifacts, Gradle vs workflow responsibilities, and best/worst practices.
  • Documents optimization strategies (detect-changes, minimal dependency installs, Git LFS usage, artifact reuse).
  • Summarizes GitHub Actions concepts relevant to the pipeline (composite actions, reusable workflows, conditional expressions).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/developer-guide/ci-cd-pipeline.md Outdated
Comment thread docs/developer-guide/ci-cd-pipeline.md Outdated
Comment thread docs/developer-guide/ci-cd-pipeline.md Outdated
Comment thread docs/developer-guide/ci-cd-pipeline.md Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5ef00fa8ea

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/developer-guide/ci-cd-pipeline.md Outdated
Comment thread docs/developer-guide/ci-cd-pipeline.md Outdated
Comment thread docs/developer-guide/ci-cd-pipeline.md Outdated
Comment thread docs/developer-guide/ci-cd-pipeline.md Outdated
Comment thread docs/developer-guide/ci-cd-pipeline.md Outdated
@Ekhorn
Ekhorn force-pushed the document/pipeline branch from c4d762a to b9ec506 Compare October 19, 2026 12:51

@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 ⚠️

Read through it against the actual workflows — checks, skip inputs, detect-changes outputs, sharding + UI App Tests Status, the tsbuildinfo trick, type=gha, the or-manager-build exception, deploy in .ci_cd/ci_cd.json, and the IS_MAIN_REPO/openremote/.ci_cd compat note all match the code, and all of #161's acceptance criteria are covered. Only open point is the merge-order dependency on openremote/core#3448 (inline at the Custom Projects section).

Comment thread docs/developer-guide/170-ci-cd-pipeline.md
Comment thread docs/developer-guide/170-ci-cd-pipeline.md Outdated
Comment thread docs/developer-guide/170-ci-cd-pipeline.md Outdated
Comment thread docs/developer-guide/170-ci-cd-pipeline.md Outdated
Comment thread docs/developer-guide/170-ci-cd-pipeline.md Outdated
Comment thread docs/developer-guide/170-ci-cd-pipeline.md Outdated
Comment thread docs/developer-guide/170-ci-cd-pipeline.md Outdated
Comment thread docs/developer-guide/170-ci-cd-pipeline.md
Comment thread docs/developer-guide/170-ci-cd-pipeline.md Outdated
@Ekhorn
Ekhorn marked this pull request as ready for review October 19, 2026 14:24
@Ekhorn
Ekhorn requested a review from a team October 19, 2026 17:05

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.

Document new pipeline changes

4 participants