Skip to content

ci: update CI readme to more current information#81

Merged
crookedstorm merged 1 commit into
mainfrom
ci-doc/crookedstorm
May 27, 2026
Merged

ci: update CI readme to more current information#81
crookedstorm merged 1 commit into
mainfrom
ci-doc/crookedstorm

Conversation

@crookedstorm
Copy link
Copy Markdown
Contributor

@crookedstorm crookedstorm commented May 27, 2026

Summary by CodeRabbit

  • Documentation
    • Expanded CI/CD workflow documentation with detailed descriptions and comprehensive catalog of available CI, deployment, and release processes, including improved clarification of workflow triggers and configurations.

Review Change Stack

Signed-off-by: Brooke Storm <brookes@nvidia.com>
@crookedstorm crookedstorm self-assigned this May 27, 2026
@crookedstorm crookedstorm requested a review from a team as a code owner May 27, 2026 22:25
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 45e1ebf2-0d56-4fd6-9012-e125cda97395

📥 Commits

Reviewing files that changed from the base of the PR and between 9d7c514 and 9517447.

📒 Files selected for processing (1)
  • .github/CI_README.md

📝 Walkthrough

Walkthrough

Updated CI documentation to provide detailed workflow catalog, including specific CI workflow files, release pipeline descriptions, and clarification of the DCO merge-queue workaround via dco-war.yaml.

Changes

CI Documentation Update

Layer / File(s) Summary
CI workflow overview and release workflows
.github/CI_README.md
Workflow Overview section expands to enumerate CI workflows with trigger conditions and job descriptions. Deployment and Release Workflows section details each release workflow and reusable implementation. GitHub Apps section clarifies current dco-war.yaml merge-queue workaround and planned removal.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed Title directly reflects the main change: updating CI documentation with more current information.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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 ci-doc/crookedstorm

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

@crookedstorm crookedstorm added this pull request to the merge queue May 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Suite Lines Covered Line Rate Branch Rate
Unit Tests 18245/24195 75.4% 61.8%
Integration Tests 11665/22977 50.8% 25.9%

Merged via the queue into main with commit 242ef13 May 27, 2026
16 checks passed
aray12 pushed a commit that referenced this pull request May 28, 2026
Signed-off-by: Brooke Storm <brookes@nvidia.com>
Signed-off-by: Alex Ray <alray@nvidia.com>
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