Skip to content

docs(gitops-update): document deployment_matrix_ref input#222

Merged
bedatty merged 1 commit intodevelopfrom
docs/document-deployment-matrix-ref
Apr 15, 2026
Merged

docs(gitops-update): document deployment_matrix_ref input#222
bedatty merged 1 commit intodevelopfrom
docs/document-deployment-matrix-ref

Conversation

@bedatty
Copy link
Copy Markdown
Contributor

@bedatty bedatty commented Apr 15, 2026

Description

Adds documentation for the deployment_matrix_ref input introduced in #212 (commit 09a52ec). Three sections of `docs/gitops-update-workflow.md` updated:

  1. Lead paragraph (line 37): replace the outdated "same pinned ref as the workflow itself" description with the current behavior (default `main`, override via `deployment_matrix_ref`).
  2. Optional inputs table (line 96): add `deployment_matrix_ref` row with default `main` and usage guidance.
  3. "How it works" step 2: rewrite to reflect the decoupling — manifest resolution is no longer tied to the pinned workflow ref, which is the whole point of the design (manifest updates propagate without tag bumps).

Addresses CodeRabbit review comment on #221 (ID 3088717994).

Type of Change

  • `feat`: New workflow or new input/output/step in an existing workflow
  • `fix`: Bug fix in a workflow
  • `perf`: Performance improvement
  • `refactor`: Internal restructuring with no behavior change
  • `docs`: Documentation only
  • `ci`: Changes to self-CI
  • `chore`: Dependency bumps, config updates, maintenance
  • `test`: Adding or updating tests
  • `BREAKING CHANGE`: Callers must update their configuration after this PR

Breaking Changes

None.

Testing

  • YAML syntax validated locally (N/A — markdown)
  • Verified all existing inputs still work with default values
  • Confirmed no secrets or tokens are printed in logs
  • Checked that unrelated workflows are not affected

Caller repo / workflow run: N/A — docs only.

Related Issues

Closes #

Summary by CodeRabbit

  • Documentation
    • Updated GitOps update workflow documentation reflecting new deployment matrix configuration retrieval behavior with main as the default branch
    • Introduced new deployment_matrix_ref input parameter allowing users to customize the Git reference used for deployment configuration
    • Modified workflow to decouple deployment matrix versioning from workflow version pinning

…fault resolution

Addresses CodeRabbit feedback on PR #221. The workflow no longer checks out
the manifest at the same ref as itself — it defaults to 'main' (via the
deployment_matrix_ref input) so manifest updates propagate to every caller
without bumping the pinned workflow tag.

- Lead paragraph: replace 'same pinned ref' description.
- Optional inputs table: add deployment_matrix_ref row.
- 'How it works' step 2: rewrite to reflect the new behavior and rationale.
@bedatty bedatty requested a review from a team as a code owner April 15, 2026 19:02
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 6d1f9964-4962-4221-9d7d-fc6f1bd3c331

📥 Commits

Reviewing files that changed from the base of the PR and between 02ce0a9 and 7687cf7.

📒 Files selected for processing (1)
  • docs/gitops-update-workflow.md

Walkthrough

Updated documentation for the update_gitops workflow to change how config/deployment-matrix.yml is retrieved. The matrix no longer uses the pinned workflow ref but defaults to main, with a configurable deployment_matrix_ref input to override the Git ref.

Changes

Cohort / File(s) Summary
Workflow Documentation
docs/gitops-update-workflow.md
Updated update_gitops workflow documentation: changed matrix checkout to default to main instead of pinned workflow ref; added new deployment_matrix_ref input parameter (default main); revised "How it works" section accordingly.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the primary change: documenting the deployment_matrix_ref input. It is concise, specific, and directly matches the content of the PR.
Description check ✅ Passed The description fully addresses the template structure with all required sections completed: description of changes, type of change (docs) marked, breaking changes stated as none, testing checklist completed, and related issues noted.
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
  • Commit unit tests in branch docs/document-deployment-matrix-ref

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

@lerian-studio lerian-studio added size/XS PR changes < 50 lines documentation Improvements or additions to documentation labels Apr 15, 2026
@lerian-studio
Copy link
Copy Markdown

🔍 Lint Analysis

Check Files Scanned Status
YAML Lint no changes ⏭️ skipped
Action Lint no changes ⏭️ skipped
Pinned Actions no changes ⏭️ skipped
Markdown Link Check 1 file(s) ✅ success
Spelling Check 1 file(s) ✅ success
Shell Check no changes ⏭️ skipped
README Check no changes ⏭️ skipped
Composite Schema no changes ⏭️ skipped
Deployment Matrix no changes ⏭️ skipped

🔍 View full scan logs

@bedatty bedatty merged commit 27f5954 into develop Apr 15, 2026
17 checks passed
@github-actions github-actions bot deleted the docs/document-deployment-matrix-ref branch April 15, 2026 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/XS PR changes < 50 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants