Skip to content

Docs: Split the vendored dependency README section into subsections - #1146

Merged
scopenhagenPickNik merged 1 commit into
mainfrom
docs/readme-vendored-deps-structure
Nov 4, 2026
Merged

scopenhagenPickNik merged 1 commit into
mainfrom
docs/readme-vendored-deps-structure

Conversation

@scopenhagenPickNik

Copy link
Copy Markdown

[written by AI]

Refs PickNikRobotics/moveit_pro#23409, follow-up to #1097.

Change

## Updating vendored dependencies in README.md was a single paragraph of about 600 words after #1027, #1096 and #1097 each added sentences to it. This PR splits it without changing what it says:

  • ### Checking drift: status and the drift_tracking: false opt-out.
  • ### Refreshing a source: one source per PR, what update does, the exit codes as a table, and the manual refresh as numbered steps.
  • ### Weekly refresh PRs: the Sunday job, the draft hold, the review as numbered steps, and the awaiting review recovery.
  • The repository_dispatch / workflow_dispatch caveat from 3374e1d is now a [!WARNING] alert.
  • The moveit_pro_sam2 sentence moves from the end of the section into its intro, with "is not vendored" added. .gitmodules lists it as a submodule, and it is not under src/external_dependencies.

Release notes

None

🤖 Generated with Claude Code

Co-Authored-By: Claude Code <noreply@anthropic.com>
@scopenhagenPickNik scopenhagenPickNik added this to the 10.2.1 milestone Nov 4, 2026
@coderabbitai

coderabbitai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Summary

Summary by CodeRabbit

  • Documentation
    • Reorganized vendored-dependency guidance into sections for checking drift, refreshing a source, and weekly refresh pull requests.
    • Clarified refresh steps, independent version updates, review flow, CI behavior, and which dispatch triggers can run integration tests before review.
    • Added an exit-code reference covering successful runs, operational or input errors, and refreshes that need conflict or manifest repairs.

The README reorganizes vendored dependency guidance into sections for checking drift, refreshing a source, and reviewing weekly refresh pull requests. It adds a table of refresh exit codes and describes CI behavior for different event types.

Changes: Vendored Dependency Guidance

Layer / File(s) Summary
Document the refresh flow
README.md
The README separates drift checks, manual and scripted refresh instructions, and weekly refresh review steps. It lists the update command’s exit codes and describes CI behavior for pull request and dispatch events.

Possibly related PRs

Suggested reviewers: jwhitleywork

Merge Risk: Minimal · up to f1fdc

The README restructuring is mergeable with no identified current-head risk.

Pre-merge checks: Passed 4
Check name Status Explanation
Description check Passed The pull request description clearly describes the README.md restructuring for vendored-dependency guidance, including subsections, exit codes, refresh procedures, workflow warnings, and the moveit_pr…
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.
Human Review Check Passed The PR changes only README.md. It restructures existing vendored-dependency guidance into subsections, a table, and numbered steps. It does not change auth, CI/CD configuration, deployment, scripts,…
Full details: Description check

Explanation

The pull request description clearly describes the README.md restructuring for vendored-dependency guidance, including subsections, exit codes, refresh procedures, workflow warnings, and the moveit_pro_sam2 note.

Full details: Human Review Check

Explanation

The PR changes only README.md. It restructures existing vendored-dependency guidance into subsections, a table, and numbered steps. It does not change auth, CI/CD configuration, deployment, scripts, APIs, or package behavior. This is a low-risk documentation change.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Team
  • Run ID: d9ed934c-6691-4c42-bc57-dfe666012c2a
Commits

Reviewing files that changed from the base of the PR and between 6e83d26 and f1fdcfc.

Files selected for processing: 1
  • README.md

Included review availability: This review used your included allowance. 9 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 10 reviews per hour.

@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown

⚠️ This PR modifies 1 file(s) that also exist in PickNikRobotics/moveit_pro_empty_ws.

Consider whether the change should land upstream in moveit_pro_empty_ws first so downstream forks pick it up on the next sync.

Overlapping files
  • README.md

@scopenhagenPickNik
scopenhagenPickNik marked this pull request as ready for review November 4, 2026 02:35
@scopenhagenPickNik
scopenhagenPickNik merged commit cf7dd1c into main Nov 4, 2026
20 checks passed
@scopenhagenPickNik
scopenhagenPickNik deleted the docs/readme-vendored-deps-structure branch November 4, 2026 02:47
@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown

MoveIt Pro Example WS - Objectives Integration Test Report

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.

1 participant